pybomwater

v0.1.3

A python tool for requesting data from BoM Sensor Observation Service (SOS2, as WaterML 2.0 format) For more information about how to use this package see README

Latest version published 21 days ago

License: (BSD-2-Clause OR MIT)

PyPI

GitHub

Package Health Score

63 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

waterloo
42

Popularity

Limited

GitHub Stars: 21
Forks: 2
Contributors: 3

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pybomwater, we found that it has been starred 21 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 29, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

(BSD-2-Clause OR MIT)

Security Policy

We found a way for you to contribute to the project! Looks like pybomwater is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 6
Open PR: 0
Last Release: 21 days ago
Last Commit: 21 days ago

Further analysis of the maintenance status of pybomwater based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that pybomwater demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like pybomwater is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <4.0,>=3.10

Age: 1 year
Latest Release: 21 days ago
Dependencies: 0 Direct
Versions: 4
Maintainers: 0
Wheels: OS Independent

Readme

BoM Water

A python tool for requesting data from BoM Sensor Observation Service (SOS2, as WaterML 2.0 format)

website

This package has been developed to access to the BoM Water Data Sensor Observation Service (SOS) with a goal to easily and efficiently integrate data into scientific workflows

License

MIT-derived (see License.txt)

Installation

From pypi:

pip install pybomwater

From source:

Using poetry
- I like to keep the .venv in my project directory so I use poetry config --local virtualenvs.in-project true
- poetry install which will install the dependencies listed in the poetry.lock
- poetry shell which is initialize the environment within your running application (eg cmd), or in VS Code Cmd+Shift+p and then type Python Interpreter and select the environment you just built.

Usage

see Jupyter Notebook example

NOTE

The first time a BomWater object is instantiated (bm = bom_water.BomWater()) a cache of data is created. This process obtains data from the BoM service and will take a little while to complete. Once cached this process is not repeated and performance will return to normal.

Documentation

Bureau of Meteorology (BoM) documentation on using their SOS service is available at the following links:

The following cells implement requests that access the BoM SOS2 service.

GetCapabilties

Lists services available and the filters that can be used to select data output by those services. It also provides an overview of parameters, time series types and geographic area covered by the services.

GetFeatureOfInterest

Provides details about a set of geographical features or locations at which observations are measured. They can be selected according to the parameter measured, type of time series available, and area or point location.

GetDataAvailability

Lists the type of data available for a ‘feature of interest’ and its coverage. This includes a list of parameters, the time series types available for each of the parameters, and the observed period of record for each time series type.

GetObservation

Returns observations of a specified ‘feature of interest’ and parameter, within a specific time series type. Each observation has a datetime, value, quality and interpolation type.

Parameter currently available via SOS2

Parameter	Water regulation Data Subcategory
Dry Air Temperature	4f
Electrical Conductivity @ 25C	9a
Evaporation	4c
Ground Water Level	2a
Rainfall	4a
Relative Humidity	4h
Storage Level	3a
Storage Volume	3b
Turbidity	9d
Water Course Discharge (standard time series types)	1b
Water Course Discharge (flood warning time series types)	11b
Water Course Level (standard time series types)	1a
Water Course Level (flood warning time series types)	11a
Water pH	9g
Water Temperature	9h
Wind Direction	4

Timeseries pattern and aggreated available

Time series name	Procedure	Identifier Time series description
DMQaQc.Merged.DailyMean.24HR	Pat1_C_B_1_DailyMean or Pat9_C_B_1_DailyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily means, reported from midnight to midnight.
DMQaQc.Merged.DailyMax.24HR	Pat1_C_B_1_DailyMax or Pat9_C_B_1_DailyMax	Maximum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight
DMQaQc.Merged.DailyMin.24HR	Pat1_C_B_1_DailyMin or Pat9_C_B_1_DailyMin	Minimum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.MonthlyMean.CalMonth	Pat1_C_B_1_MonthlyMean or Pat9_C_B_1_MonthlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to monthly means.
DMQaQc.Merged.YearlyMean.CalYear	Pat1_C_B_1_YearlyMean or Pat9_C_B_1_YearlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to yearly means.
DMQaQc.Merged.DailyTotal.09HR	Pat2_C_B_1_DailyTot09	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily totals, reported from 9am to 9am.
DMQaQc.Merged.DailyTotal.24HR	Pat2_C_B_1_DailyTot24	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily totals,reported from midnight to midnight.
DMQaQc.Merged.MonthlyTotal.CalMonth	Pat2_C_B_1_MonthlyTot24	DMQaQc.Merged.AsStored.1 timeseries aggregated to monthly totals.
DMQaQc.Merged.YearlyTotal.CalYear	Pat2_C_B_1_YearlyTot24	DMQaQc.Merged.AsStored.1 timeseries aggregated to yearly totals.
DMQaQc.Merged.HourlyMean.HR	Pat3_C_B_1_HourlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to hourly means.
DMQaQc.Merged.DailyMean.24HR	Pat3_C_B_1_DailyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily means, reported from midnight to midnight.
DMQaQc.Merged.DailyMax.24HR	Pat3_C_B_1_DailyMax	Maximum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.DailyMin.24HR	Pat3_C_B_1_DailyMin	Minimum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.MonthlyMean.CalMonth	Pat3_C_B_1_MonthlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to monthly means.
DMQaQc.Merged.YearlyMean.CalYear	Pat3_C_B_1_YearlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to yearly means.
DMQaQc.Merged.HourlyMean.HR	Pat4_C_B_1_HourlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to hourly means.
DMQaQc.Merged.DailyMean.09HR	Pat4_C_B_1_DailyMean09	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily means, reported from 9am to 9am.
DMQaQc.Merged.DailyMax.24HR	Pat4_C_B_1_DailyMax	Maximum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.DailyMin.24HR	Pat4_C_B_1_DailyMin	Minimum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.DailyMean.24HR	Pat4_C_B_1_DailyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily means, reported from midnight to midnight.
DMQaQc.Merged.MonthlyMean.CalMonth	Pat4_C_B_1_MonthlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to monthly means.
DMQaQc.Merged.YearlyMean.CalYear	Pat4_C_B_1_YearlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to yearly means.
DMQaQc.Merged.HourlyMean.HR	Pat6_C_B_1_HourlyMean or Pat7_C_B_1_HourlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to hourly means.
DMQaQc.Merged.DailyMean.24HR	Pat6_C_B_1_DailyMean or Pat7_C_B_1_DailyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to daily means, reported from midnight to midnight.
DMQaQc.Merged.DailyMax.24HR	Pat6_C_B_1_DailyMax or Pat7_C_B_1_DailyMax	Maximum of values in theDMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.DailyMin.24HR	Pat6_C_B_1_DailyMin or Pat7_C_B_1_DailyMin	Minimum of values in the DMQaQc.Merged.AsStored.1 timeseries - from midnight to midnight.
DMQaQc.Merged.MonthlyMean.CalMonth	Pat6_C_B_1_MonthlyMean or Pat7_C_B_1_MonthlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to monthly means.
DMQaQc.Merged.YearlyMean.CalYear	Pat6_C_B_1_YearlyMean or Pat7_C_B_1_YearlyMean	DMQaQc.Merged.AsStored.1 timeseries aggregated to yearly means.

Task list

FAQs

What is pybomwater?

A python tool for requesting data from BoM Sensor Observation Service (SOS2, as WaterML 2.0 format). Visit Snyk Advisor to see a full health score report for pybomwater, including popularity, security, maintenance & community analysis.

Is pybomwater popular?

The python package pybomwater receives a total of 32 weekly downloads. As such, pybomwater popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pybomwater well maintained?

We found indications that pybomwater maintenance is sustainable demonstrating some project activity. We saw a total of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is pybomwater safe to use?

The python package pybomwater was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 December-2024, at 06:32 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

BoM Water

License

Installation

Usage

Documentation

The following cells implement requests that access the BoM SOS2 service.

GetCapabilties

GetFeatureOfInterest

GetDataAvailability

GetObservation

Parameter currently available via SOS2

Timeseries pattern and aggreated available

Task list

FAQs

What is pybomwater?

Is pybomwater popular?

Is pybomwater well maintained?

Is pybomwater safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues