pyreclaim 0.1.0__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/PKG-INFO +21 -4
  2. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/README.md +20 -3
  3. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/pyproject.toml +1 -1
  4. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/setup.py +1 -1
  5. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/pyreclaim.egg-info/PKG-INFO +21 -4
  6. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/LICENSE +0 -0
  7. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/setup.cfg +0 -0
  8. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/pyreclaim.egg-info/SOURCES.txt +0 -0
  9. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/pyreclaim.egg-info/dependency_links.txt +0 -0
  10. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/pyreclaim.egg-info/requires.txt +0 -0
  11. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/pyreclaim.egg-info/top_level.txt +0 -0
  12. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/__init__.py +0 -0
  13. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/derived_features/__init__.py +0 -0
  14. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/derived_features/feature_engineering_and_transformation.py +0 -0
  15. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/__init__.py +0 -0
  16. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/catchment_dynamic.py +0 -0
  17. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/reservoir_dynamic.py +0 -0
  18. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/utils/__init__.py +0 -0
  19. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/utils/catchment_meteorology.py +0 -0
  20. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/utils/inflow_outflow.py +0 -0
  21. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/utils/rainfall.py +0 -0
  22. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/utils/statistical_metrics.py +0 -0
  23. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/dynamic_features/utils/ts_aggregate.py +0 -0
  24. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/generate_features.py +0 -0
  25. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/reclaim.py +0 -0
  26. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/__init__.py +0 -0
  27. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/catchment_static.py +0 -0
  28. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/reservoir_static.py +0 -0
  29. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/utils/__init__.py +0 -0
  30. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/utils/aec_shape.py +0 -0
  31. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/utils/area_perimeter.py +0 -0
  32. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/utils/catchment_agreggate.py +0 -0
  33. {pyreclaim-0.1.0 → pyreclaim-0.3.0}/src/reclaim/static_features/utils/flow_length.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyreclaim
3
- Version: 0.1.0
3
+ Version: 0.3.0
4
4
  Summary: Reservoir Estimation of Capacity Loss using AI based Methods
5
5
  Author-email: Sanchit Minocha <msanchit@uw.edu>
6
6
  License: GNU GENERAL PUBLIC LICENSE
@@ -700,8 +700,14 @@ Requires-Dist: lightgbm
700
700
  Requires-Dist: catboost
701
701
  Dynamic: license-file
702
702
 
703
- ![Reservoir Estimation of Capacity Loss using AI-based Methods](docs/_static/Reclaim_logo_clearBG.png)
704
- # Reservoir Estimation of Capacity Loss using AI-based Methods - RECLAIM
703
+ <div align="center">
704
+ <img src="https://github.com/UW-SASWE/RECLAIM/raw/main/docs/_static/Reclaim_logo_clearBG.png" alt="Reservoir Estimation of Capacity Loss using AI-based Methods" width="500"/>
705
+ </div>
706
+
707
+
708
+ # Reservoir Estimation of Capacity Loss using AI-based Methods (RECLAIM)
709
+
710
+ ---
705
711
 
706
712
  **First-of-its-kind globally scalable tool to predict reservoir sedimentation, screen vulnerable reservoirs, and pinpoint those struggling the most.**
707
713
 
@@ -723,10 +729,21 @@ It is the **first-of-its-kind tool** to:
723
729
  Install the package via pip:
724
730
 
725
731
  ```bash
726
- pip install reclaim
732
+ pip install pyreclaim
727
733
  ```
734
+
728
735
  ---
736
+ ## Download Data
729
737
 
738
+ To generate features for reservoirs using the **RECLAIM** framework and the [`pyreclaim`](https://pypi.org/project/pyreclaim/) Python package, you will need the global datasets.
739
+
740
+ You can download all required global datasets from the Open Science Framework (OSF):
741
+
742
+ [Download Global Datasets](https://doi.org/10.5281/zenodo.17230533)
743
+
744
+ These datasets include land cover, soil, terrain/DEM derivatives, and vegetation gain/loss data, which are essential for computing reservoir and catchment features for RECLAIM.
745
+
746
+ ---
730
747
  ## Documentation
731
748
 
732
749
  The documentation is available [here](https://reclaimio.readthedocs.io/en/latest/).
@@ -1,5 +1,11 @@
1
- ![Reservoir Estimation of Capacity Loss using AI-based Methods](docs/_static/Reclaim_logo_clearBG.png)
2
- # Reservoir Estimation of Capacity Loss using AI-based Methods - RECLAIM
1
+ <div align="center">
2
+ <img src="https://github.com/UW-SASWE/RECLAIM/raw/main/docs/_static/Reclaim_logo_clearBG.png" alt="Reservoir Estimation of Capacity Loss using AI-based Methods" width="500"/>
3
+ </div>
4
+
5
+
6
+ # Reservoir Estimation of Capacity Loss using AI-based Methods (RECLAIM)
7
+
8
+ ---
3
9
 
4
10
  **First-of-its-kind globally scalable tool to predict reservoir sedimentation, screen vulnerable reservoirs, and pinpoint those struggling the most.**
5
11
 
@@ -21,10 +27,21 @@ It is the **first-of-its-kind tool** to:
21
27
  Install the package via pip:
22
28
 
23
29
  ```bash
24
- pip install reclaim
30
+ pip install pyreclaim
25
31
  ```
32
+
26
33
  ---
34
+ ## Download Data
27
35
 
36
+ To generate features for reservoirs using the **RECLAIM** framework and the [`pyreclaim`](https://pypi.org/project/pyreclaim/) Python package, you will need the global datasets.
37
+
38
+ You can download all required global datasets from the Open Science Framework (OSF):
39
+
40
+ [Download Global Datasets](https://doi.org/10.5281/zenodo.17230533)
41
+
42
+ These datasets include land cover, soil, terrain/DEM derivatives, and vegetation gain/loss data, which are essential for computing reservoir and catchment features for RECLAIM.
43
+
44
+ ---
28
45
  ## Documentation
29
46
 
30
47
  The documentation is available [here](https://reclaimio.readthedocs.io/en/latest/).
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "pyreclaim"
7
- version = "0.1.0"
7
+ version = "v0.3.0"
8
8
  authors = [
9
9
  { name="Sanchit Minocha", email="msanchit@uw.edu" },
10
10
  ]
@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
3
3
 
4
4
  setup(
5
5
  name = "pyreclaim",
6
- version = "0.1.0",
6
+ version = "v0.3.0",
7
7
  license = "GPL-3.0",
8
8
  package_dir = {"": "src"}
9
9
  )
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyreclaim
3
- Version: 0.1.0
3
+ Version: 0.3.0
4
4
  Summary: Reservoir Estimation of Capacity Loss using AI based Methods
5
5
  Author-email: Sanchit Minocha <msanchit@uw.edu>
6
6
  License: GNU GENERAL PUBLIC LICENSE
@@ -700,8 +700,14 @@ Requires-Dist: lightgbm
700
700
  Requires-Dist: catboost
701
701
  Dynamic: license-file
702
702
 
703
- ![Reservoir Estimation of Capacity Loss using AI-based Methods](docs/_static/Reclaim_logo_clearBG.png)
704
- # Reservoir Estimation of Capacity Loss using AI-based Methods - RECLAIM
703
+ <div align="center">
704
+ <img src="https://github.com/UW-SASWE/RECLAIM/raw/main/docs/_static/Reclaim_logo_clearBG.png" alt="Reservoir Estimation of Capacity Loss using AI-based Methods" width="500"/>
705
+ </div>
706
+
707
+
708
+ # Reservoir Estimation of Capacity Loss using AI-based Methods (RECLAIM)
709
+
710
+ ---
705
711
 
706
712
  **First-of-its-kind globally scalable tool to predict reservoir sedimentation, screen vulnerable reservoirs, and pinpoint those struggling the most.**
707
713
 
@@ -723,10 +729,21 @@ It is the **first-of-its-kind tool** to:
723
729
  Install the package via pip:
724
730
 
725
731
  ```bash
726
- pip install reclaim
732
+ pip install pyreclaim
727
733
  ```
734
+
728
735
  ---
736
+ ## Download Data
729
737
 
738
+ To generate features for reservoirs using the **RECLAIM** framework and the [`pyreclaim`](https://pypi.org/project/pyreclaim/) Python package, you will need the global datasets.
739
+
740
+ You can download all required global datasets from the Open Science Framework (OSF):
741
+
742
+ [Download Global Datasets](https://doi.org/10.5281/zenodo.17230533)
743
+
744
+ These datasets include land cover, soil, terrain/DEM derivatives, and vegetation gain/loss data, which are essential for computing reservoir and catchment features for RECLAIM.
745
+
746
+ ---
730
747
  ## Documentation
731
748
 
732
749
  The documentation is available [here](https://reclaimio.readthedocs.io/en/latest/).
File without changes
File without changes