py-ewr 2.0.0__py3-none-any.whl → 2.1.2__py3-none-any.whl

py_ewr-2.0.0.dist-info/METADATA

@@ -1,190 +0,0 @@
-Metadata-Version: 2.1
-Name: py-ewr
-Version: 2.0.0
-Summary: Environmental Water Requirement calculator
-Home-page: https://github.com/MDBAuth/EWR_tool
-Author: Martin Job
-Author-email: Martin.Job@mdba.gov.au
-Project-URL: Bug Tracker, https://github.com/MDBAuth/EWR_tool/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License (GPL)
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Framework :: Pytest
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ipython ==8.8.0
-Requires-Dist: ipywidgets ==7.7.0
-Requires-Dist: pandas ==2.0.3
-Requires-Dist: requests ==2.25.1
-Requires-Dist: tqdm ==4.64.0
-Requires-Dist: mdba-gauge-getter ==0.5.0
-Requires-Dist: cachetools ==5.2.0
-
-[![CI](https://github.com/MDBAuth/EWR_tool/actions/workflows/test-release.yml/badge.svg)]()
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/py-ewr)](https://pypi.org/project/py-ewr/)
-[![PyPI](https://img.shields.io/pypi/v/py-ewr)](https://pypi.org/project/py-ewr/)
-[![DOI](https://zenodo.org/badge/342122359.svg)](https://zenodo.org/badge/latestdoi/342122359)
-
-### **EWR tool version 2.0.0 README**
-
-### **Installation**
-
-Note - requires Python 3.8 or newer
-
-Step 1. 
-Upgrade pip
-```bash
-python -m pip install –-upgrade pip
-```
-
-Step 2.
-```bash
-pip install py-ewr
-``` 
-
-### Run Timeseries with ObservedHandler
-
-```python
-from datetime import datetime
-
-from py_ewr.observed_handling import ObservedHandler
-
-dates = {'start_date': datetime(2020, 7, 1), 
-        'end_date': datetime(2021, 6, 30)}
-
-# Get allowances:
-
-MINT = (100 - 0)/100
-MAXT = (100 + 0 )/100
-DUR = (100 - 0 )/100
-DRAW = (100 -0 )/100
-
-allowance ={'minThreshold': MINT, 'maxThreshold': MAXT, 'duration': DUR, 'drawdown': DRAW}
-
-gauges = ['419039']
-climate = "Standard - 1911 to 2018 climate categorisation"
-
-# instantiate ObservedHandler
-
-ewr_oh = ObservedHandler(gauges=gauges, dates=dates , allowance=allowance, climate=climate)
-
-
-# ObservedHandler methods
-
-# returns a pandas DataFrame with ewr results for the timeseries
-ewr_results = ewr_oh.get_ewr_results()
-
-# returns a pandas DataFrame with the yearly ewr results for the timeseries
-yearly_ewr_results = ewr_oh.get_yearly_ewr_results()
-
-# returns a pandas DataFrame with all events of the timeseries
-all_events = ewr_oh.get_all_events()
-
-# returns a pandas DataFrame with all interEvents of the timeseries
-all_interEvents = ewr_oh.get_all_interEvents()
-
-# returns a pandas DataFrame with all successful events of the timeseries
-all_successfulEvents = ewr_oh.get_all_successful_events()
-
-# returns a pandas DataFrame with all interevent periods between the successful events of the timeseries
-all_successful_interEvents = ewr_oh.get_all_successful_interEvents()
-
-
-# with the returned object you can use any pandas method like pd.DateFrame.to_csv() etc.
-
-```
-
-### Run Timeseries with ScenarioHandler
-
-```python
-from py_ewr.scenario_handling import ScenarioHandler
-
-# pass a list of location of the scenario files
-# this example will pass a IQQDM format scenario read the pdf manual for details
-loaded_files = ["419039_gauge_data_IQQDM.csv"]
-
-# Get allowances:
-
-MINT = (100 - 0)/100
-MAXT = (100 + 0 )/100
-DUR = (100 - 0 )/100
-DRAW = (100 -0 )/100
-
-allowance ={'minThreshold': MINT, 'maxThreshold': MAXT, 'duration': DUR, 'drawdown': DRAW}
-
-# Current model format options: 'Bigmod - MDBA', 'Source - NSW (res.csv)', 'IQQM - NSW 10,000 years' - see manual for formatting requirements
-ewr_sh = ScenarioHandler(scenario_files = loaded_files, 
-                         model_format = 'IQQM - NSW 10,000 years', 
-                         allowance = allowance, 
-                         climate = 'Standard - 1911 to 2018 climate categorisation' )
-
-
-# ScenarioHandler methods
-
-# returns a pandas DataFrame with ewr results for the timeseries
-ewr_results = ewr_sh.get_ewr_results()
-
-# returns a pandas DataFrame with the yearly ewr results for the timeseries
-yearly_ewr_results = ewr_sh.get_yearly_ewr_results()
-
-# returns a pandas DataFrame with all events of the timeseries
-all_events = ewr_sh.get_all_events()
-
-# returns a pandas DataFrame with all interEvents of the timeseries
-all_interEvents = ewr_sh.get_all_interEvents()
-
-# returns a pandas DataFrame with all successful events of the timeseries
-all_successfulEvents = ewr_sh.get_all_successful_events()
-
-# returns a pandas DataFrame with all interevent periods between the successful events of the timeseries
-all_successful_interEvents = ewr_sh.get_all_successful_interEvents()
-
-# with the returned object you can use any pandas method like pd.DateFrame.to_csv() etc.
-
-```
-
-### **Purpose**
-This tool has two purposes:
-1. Operational: Tracking EWR success at gauges of interest in real time.
-2. Planning: Comparing EWR success between scenarios (i.e. model runs)
-
-**Support**
-For issues relating to the script, a tutorial, or feedback please contact Lara Palmer at lara.palmer@mdba.gov.au, Martin Job at martin.job@mdba.gov.au, or Joel Bailey at joel.bailey@mdba.gov.au
-
-
-**Disclaimer**
-Every effort has been taken to ensure the EWR database represents the original EWRs from state long term water plans as best as possible, and that the code within this tool has been developed to interpret and analyse these EWRs in an accurate way. However, there may still be unresolved bugs in the database and/or EWR tool. Please report any bugs to the issues tab under this GitHub project so we can investigate further. 
-
-
-**Notes on development of the dataset of EWRs**
-The MDBA has worked with NSW to ensure scientific robustness of EWRs has been maintained when translating from raw EWRs in the LTWPs to the machine readable format found in the dataset used by this tool. 
-
-**Compatibility**
-
-NSW:
-- All NSW catchments
-
-Work is currently underway to migrate the EWRs in the remaining Basin catchments.
-
-**Input data**
-- EWR information: This tool accesses the EWRs in the Environmental Assets & Functions Database (EAFD)
-- Climate data from the AWRA-L model
-- Gauge data from the relevant state websites
-- Scenario data input by the user
-- Model metadata for location association between gauge ID's and model nodes
-
-**Running the tool**
-Consult the user manual for instructions on how to run the tool. Please email the above email addresses for a copy of the user manual.
-
-**Climate sequence**
-NSW Long Term Watering Plans (LTWP) define climate using the Resource Availability Scenarios (RAS). However, until this process can be completed the climate categories defined using outputs from the AWRA-L model will be used. 
-In the current version of the tool the climate sequence is not used.
-
-

py_ewr-2.0.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-py_ewr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-py_ewr/data_inputs.py,sha256=tBSqSwORvwCfBjgmrmx3XzVR7bA7rRvqjdi_jghQ_fk,26795
-py_ewr/evaluate_EWRs.py,sha256=4xdoWkWi6w_eqtnzPPmLy9weVlL7Kk0HuPbbDvEInRo,273559
-py_ewr/observed_handling.py,sha256=5ypCpthFuoTaHCMS5yYYoAC4tkUO9oFZW9H2n6s4xo8,18560
-py_ewr/scenario_handling.py,sha256=PAILFIVIeC2sOPsYmCEULIDgzVxigVTlZ5Gl214kNS4,26493
-py_ewr/summarise_results.py,sha256=smLSSdPc11G6dQuXcXrrDrM70IeyPUpB3o0LYJfA7DU,29983
-py_ewr/climate_data/climate_cats.csv,sha256=6-kdl2LGZsaWewvF1_2MKg86xTi7FSQNFtv7ErHwCN0,21459
-py_ewr/climate_data/climate_cats_10000year.csv,sha256=UJGVS_8K_vvGskcQ-qEKDlL-2LOcpp9N9xZr7IE3FBM,269220
-py_ewr/model_metadata/SiteID_MDBA.csv,sha256=M4osmvCQq6PKuZEXw0Tk-Y1WmX5Tna3c5RGQdDPQrvE,158958
-py_ewr/model_metadata/SiteID_NSW.csv,sha256=UVBxN43Z5KWCvWhQ5Rh6TNEn35q4_sjPxKyHg8wPFws,6805
-py_ewr/parameter_metadata/ewr_calc_config.json,sha256=asKPuwx9tfwZ-7AK47tQb58j0-DnqvicbIyzLzrlEao,17558
-py_ewr/parameter_metadata/parameter_sheet.csv,sha256=jF6qW9LDwvLxZdBuMfA6NJZ1l62AovIs2YNn8tj-mDk,617996
-py_ewr-2.0.0.dist-info/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
-py_ewr-2.0.0.dist-info/METADATA,sha256=GNlJ6OZRTLRmbPjLhT__XY6y8L5glvS7_EiAB2Kpsh4,6979
-py_ewr-2.0.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-py_ewr-2.0.0.dist-info/top_level.txt,sha256=n3725d-64Cjyb-YMUMV64UAuIflzUh2_UZSxiIbrur4,7
-py_ewr-2.0.0.dist-info/RECORD,,