HBV-Lab 0.2.2__tar.gz → 1.0.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 (19) hide show
  1. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/HBV_model.py +3 -3
  2. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab.egg-info/PKG-INFO +11 -9
  3. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/PKG-INFO +11 -9
  4. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/README.md +10 -8
  5. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/setup.py +1 -1
  6. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/__init__.py +0 -0
  7. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/calibration.py +0 -0
  8. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/hbv_step.py +0 -0
  9. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/response.py +0 -0
  10. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/routing.py +0 -0
  11. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/snow.py +0 -0
  12. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/soil.py +0 -0
  13. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/uncertainty.py +0 -0
  14. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab.egg-info/SOURCES.txt +0 -0
  15. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab.egg-info/dependency_links.txt +0 -0
  16. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab.egg-info/requires.txt +0 -0
  17. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab.egg-info/top_level.txt +0 -0
  18. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/LICENSE +0 -0
  19. {hbv_lab-0.2.2 → hbv_lab-1.0.0}/setup.cfg +0 -0
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/HBV_model.py RENAMED
@@ -24,8 +24,8 @@ import datetime
24
24
  from types import MethodType
25
25
  from .uncertainty import uncertainty
26
26
  from .calibration import calibration
27
- # from calibration import calibrate_hbv_model
28
- # from uncertainty import evaluate_uncertainty
27
+ ## from calibration import calibrate_hbv_model
28
+ ## from uncertainty import evaluate_uncertainty
29
29
  from .hbv_step import hbv_step
30
30
  from .routing import route_with_maxbas
31
31
 
@@ -71,7 +71,7 @@ class HBVModel(uncertainty, calibration):
71
71
  'lower_storage': 20.0 # Lower zone storage (mm)
72
72
  }
73
73
 
74
- # Initialize time tracking
74
+ ## Initialize time tracking
75
75
  self.start_date = None
76
76
  self.end_date = None
77
77
  self.time_step = 'D' # Default: daily
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: HBV_Lab
3
- Version: 0.2.2
3
+ Version: 1.0.0
4
4
  Summary: An intuitive, object-oriented and user-friendly Python implementation of a lumped conceptual HBV hydrological model for educational and research purposes.
5
5
  Home-page: https://github.com/abdallaox/HBV_python_implementation
6
6
  Author: Abdalla Mohammed
@@ -39,7 +39,7 @@ HBV is a simple conceptual hydrological model that simulates the main hydrologic
39
39
 
40
40
  I've been experimenting with the model lately and—in an endeavour to better understand the logic behind it—I decided to implement my own version—in Python, following an intuitive object-oriented programming approach.
41
41
 
42
- This versioin implements the snow, soil, response and routing routines—controled by 14 calibratable parameters as shown below. In addition to calibration and uncertainty analysis modules.
42
+ This versioin implements the snow, soil, response and routing routines—controled by 14 calibratable parameters as shown below—In addition to calibration and uncertainty analysis modules. See the [documentation for one step of the model.](https://lucid.app/publicSegments/view/a0edb3b6-8eba-4db5-9984-bfd23cc004ef/image.png)
43
43
  ```python
44
44
  parameters = {
45
45
  'snow': ['TT', 'CFMAX', 'SFCF', 'CFR', 'CWH'],
@@ -55,8 +55,9 @@ This can be flexibly used for different modelling tasks, but can also be used in
55
55
  ## Get Started
56
56
 
57
57
  ### Install the Package
58
- ```bash
59
- pip install HBV_Lab
58
+ ```python
59
+ pip install HBV_Lab or
60
+ ! pip install HBV_Lab
60
61
  ```
61
62
  ### How to Use
62
63
  It is very intuitive—you create a model like an object which has attributes (data, parameters, initial conditions, etc.) that you can assign and access. The object also performs functions (calibration, uncertainty estimation, save, load, etc.)
@@ -76,11 +77,12 @@ model.load_model("path")
76
77
  ### Tutorial
77
78
  Start by following a simple case study in the notebook: [**quick_start_guide.ipynb**](https://github.com/abdallaox/HBV_python_implementation/blob/main/quick_start_guide.ipynb)
78
79
  ### Play with HBV
79
- Get a feeling of how HBV model work and the role of the different parameters in [**HBVLAB**](https://hbv-playground.onrender.com/HBV_playground) (which uses a model developed with this HBV implementation).
80
- ### References
81
- **[1]** Bergström, S., & Forsman, A. (1973). DEVELOPMENT OF A CONCEPTUAL DETERMINISTIC RAINFALL-RUNOFF MODEL. Hydrology Research, 4, 147-170.
80
+ Get a feeling of how the model works and the role of the different parameters in [**HBVLAB**](https://hbv-playground.onrender.com/HBV_playground)—a playground that uses a model developed with this implementation.
81
+ ### References
82
82
 
83
- **[2]** Seibert, J. and Vis, M. J. P.: Teaching hydrological modeling with a user-friendly catchment-runoff-model software package, Hydrol. Earth Syst. Sci., 16, 3315–3325, https://doi.org/10.5194/hess-16-3315-2012, 2012.
83
+ **[1]** Bergström, S., & Forsman, A. (1973). Development of a conceptual deterministic rainfall-runoff model. *Hydrology Research*, *4*, 147-170.
84
84
 
85
- **[3]** AghaKouchak, A., Nakhjiri, N., and Habib, E.: An educational model for ensemble streamflow simulation and uncertainty analysis, Hydrol. Earth Syst. Sci., 17, 445–452, https://doi.org/10.5194/hess-17-445-2013, 2013.
85
+ **[2]** Seibert, J., & Vis, M. J. P. (2012). Teaching hydrological modeling with a user-friendly catchment-runoff-model software package. *Hydrology and Earth System Sciences*, *16*(9), 3315-3325. [doi:10.5194/hess-16-3315-2012](https://doi.org/10.5194/hess-16-3315-2012)
86
+
87
+ **[3]** AghaKouchak, A., Nakhjiri, N., & Habib, E. (2013). An educational model for ensemble streamflow simulation and uncertainty analysis. *Hydrology and Earth System Sciences*, *17*(2), 445-452. [doi:10.5194/hess-17-445-2013](https://doi.org/10.5194/hess-17-445-2013)
86
88
 
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: HBV_Lab
3
- Version: 0.2.2
3
+ Version: 1.0.0
4
4
  Summary: An intuitive, object-oriented and user-friendly Python implementation of a lumped conceptual HBV hydrological model for educational and research purposes.
5
5
  Home-page: https://github.com/abdallaox/HBV_python_implementation
6
6
  Author: Abdalla Mohammed
@@ -39,7 +39,7 @@ HBV is a simple conceptual hydrological model that simulates the main hydrologic
39
39
 
40
40
  I've been experimenting with the model lately and—in an endeavour to better understand the logic behind it—I decided to implement my own version—in Python, following an intuitive object-oriented programming approach.
41
41
 
42
- This versioin implements the snow, soil, response and routing routines—controled by 14 calibratable parameters as shown below. In addition to calibration and uncertainty analysis modules.
42
+ This versioin implements the snow, soil, response and routing routines—controled by 14 calibratable parameters as shown below—In addition to calibration and uncertainty analysis modules. See the [documentation for one step of the model.](https://lucid.app/publicSegments/view/a0edb3b6-8eba-4db5-9984-bfd23cc004ef/image.png)
43
43
  ```python
44
44
  parameters = {
45
45
  'snow': ['TT', 'CFMAX', 'SFCF', 'CFR', 'CWH'],
@@ -55,8 +55,9 @@ This can be flexibly used for different modelling tasks, but can also be used in
55
55
  ## Get Started
56
56
 
57
57
  ### Install the Package
58
- ```bash
59
- pip install HBV_Lab
58
+ ```python
59
+ pip install HBV_Lab or
60
+ ! pip install HBV_Lab
60
61
  ```
61
62
  ### How to Use
62
63
  It is very intuitive—you create a model like an object which has attributes (data, parameters, initial conditions, etc.) that you can assign and access. The object also performs functions (calibration, uncertainty estimation, save, load, etc.)
@@ -76,11 +77,12 @@ model.load_model("path")
76
77
  ### Tutorial
77
78
  Start by following a simple case study in the notebook: [**quick_start_guide.ipynb**](https://github.com/abdallaox/HBV_python_implementation/blob/main/quick_start_guide.ipynb)
78
79
  ### Play with HBV
79
- Get a feeling of how HBV model work and the role of the different parameters in [**HBVLAB**](https://hbv-playground.onrender.com/HBV_playground) (which uses a model developed with this HBV implementation).
80
- ### References
81
- **[1]** Bergström, S., & Forsman, A. (1973). DEVELOPMENT OF A CONCEPTUAL DETERMINISTIC RAINFALL-RUNOFF MODEL. Hydrology Research, 4, 147-170.
80
+ Get a feeling of how the model works and the role of the different parameters in [**HBVLAB**](https://hbv-playground.onrender.com/HBV_playground)—a playground that uses a model developed with this implementation.
81
+ ### References
82
82
 
83
- **[2]** Seibert, J. and Vis, M. J. P.: Teaching hydrological modeling with a user-friendly catchment-runoff-model software package, Hydrol. Earth Syst. Sci., 16, 3315–3325, https://doi.org/10.5194/hess-16-3315-2012, 2012.
83
+ **[1]** Bergström, S., & Forsman, A. (1973). Development of a conceptual deterministic rainfall-runoff model. *Hydrology Research*, *4*, 147-170.
84
84
 
85
- **[3]** AghaKouchak, A., Nakhjiri, N., and Habib, E.: An educational model for ensemble streamflow simulation and uncertainty analysis, Hydrol. Earth Syst. Sci., 17, 445–452, https://doi.org/10.5194/hess-17-445-2013, 2013.
85
+ **[2]** Seibert, J., & Vis, M. J. P. (2012). Teaching hydrological modeling with a user-friendly catchment-runoff-model software package. *Hydrology and Earth System Sciences*, *16*(9), 3315-3325. [doi:10.5194/hess-16-3315-2012](https://doi.org/10.5194/hess-16-3315-2012)
86
+
87
+ **[3]** AghaKouchak, A., Nakhjiri, N., & Habib, E. (2013). An educational model for ensemble streamflow simulation and uncertainty analysis. *Hydrology and Earth System Sciences*, *17*(2), 445-452. [doi:10.5194/hess-17-445-2013](https://doi.org/10.5194/hess-17-445-2013)
86
88
 
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/README.md RENAMED
@@ -4,7 +4,7 @@ HBV is a simple conceptual hydrological model that simulates the main hydrologic
4
4
 
5
5
  I've been experimenting with the model lately and—in an endeavour to better understand the logic behind it—I decided to implement my own version—in Python, following an intuitive object-oriented programming approach.
6
6
 
7
- This versioin implements the snow, soil, response and routing routines—controled by 14 calibratable parameters as shown below. In addition to calibration and uncertainty analysis modules.
7
+ This versioin implements the snow, soil, response and routing routines—controled by 14 calibratable parameters as shown below—In addition to calibration and uncertainty analysis modules. See the [documentation for one step of the model.](https://lucid.app/publicSegments/view/a0edb3b6-8eba-4db5-9984-bfd23cc004ef/image.png)
8
8
  ```python
9
9
  parameters = {
10
10
  'snow': ['TT', 'CFMAX', 'SFCF', 'CFR', 'CWH'],
@@ -20,8 +20,9 @@ This can be flexibly used for different modelling tasks, but can also be used in
20
20
  ## Get Started
21
21
 
22
22
  ### Install the Package
23
- ```bash
24
- pip install HBV_Lab
23
+ ```python
24
+ pip install HBV_Lab or
25
+ ! pip install HBV_Lab
25
26
  ```
26
27
  ### How to Use
27
28
  It is very intuitive—you create a model like an object which has attributes (data, parameters, initial conditions, etc.) that you can assign and access. The object also performs functions (calibration, uncertainty estimation, save, load, etc.)
@@ -41,11 +42,12 @@ model.load_model("path")
41
42
  ### Tutorial
42
43
  Start by following a simple case study in the notebook: [**quick_start_guide.ipynb**](https://github.com/abdallaox/HBV_python_implementation/blob/main/quick_start_guide.ipynb)
43
44
  ### Play with HBV
44
- Get a feeling of how HBV model work and the role of the different parameters in [**HBVLAB**](https://hbv-playground.onrender.com/HBV_playground) (which uses a model developed with this HBV implementation).
45
- ### References
46
- **[1]** Bergström, S., & Forsman, A. (1973). DEVELOPMENT OF A CONCEPTUAL DETERMINISTIC RAINFALL-RUNOFF MODEL. Hydrology Research, 4, 147-170.
45
+ Get a feeling of how the model works and the role of the different parameters in [**HBVLAB**](https://hbv-playground.onrender.com/HBV_playground)—a playground that uses a model developed with this implementation.
46
+ ### References
47
47
 
48
- **[2]** Seibert, J. and Vis, M. J. P.: Teaching hydrological modeling with a user-friendly catchment-runoff-model software package, Hydrol. Earth Syst. Sci., 16, 3315–3325, https://doi.org/10.5194/hess-16-3315-2012, 2012.
48
+ **[1]** Bergström, S., & Forsman, A. (1973). Development of a conceptual deterministic rainfall-runoff model. *Hydrology Research*, *4*, 147-170.
49
49
 
50
- **[3]** AghaKouchak, A., Nakhjiri, N., and Habib, E.: An educational model for ensemble streamflow simulation and uncertainty analysis, Hydrol. Earth Syst. Sci., 17, 445–452, https://doi.org/10.5194/hess-17-445-2013, 2013.
50
+ **[2]** Seibert, J., & Vis, M. J. P. (2012). Teaching hydrological modeling with a user-friendly catchment-runoff-model software package. *Hydrology and Earth System Sciences*, *16*(9), 3315-3325. [doi:10.5194/hess-16-3315-2012](https://doi.org/10.5194/hess-16-3315-2012)
51
+
52
+ **[3]** AghaKouchak, A., Nakhjiri, N., & Habib, E. (2013). An educational model for ensemble streamflow simulation and uncertainty analysis. *Hydrology and Earth System Sciences*, *17*(2), 445-452. [doi:10.5194/hess-17-445-2013](https://doi.org/10.5194/hess-17-445-2013)
51
53
 
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/setup.py RENAMED
@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as f:
5
5
 
6
6
  setup(
7
7
  name='HBV_Lab',
8
- version='0.2.2',
8
+ version='1.0.0',
9
9
  packages=find_packages(include=['HBV_Lab', 'HBV_Lab.*']),
10
10
  install_requires=[
11
11
  'numpy',
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/__init__.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/calibration.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/hbv_step.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/response.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/routing.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/snow.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/soil.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/HBV_Lab/uncertainty.py RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/LICENSE RENAMED
File without changes
{hbv_lab-0.2.2 → hbv_lab-1.0.0}/setup.cfg RENAMED
File without changes