Updated version. Ready to Release

En la rama main
Tu rama está actualizada con 'origin/main'.

Cambios a ser confirmados:
	modificados:     .zenodo.json
	modificados:     CITATION.cff
	modificados:     setup.py
	modificados:     utils/zenodo.json

.zenodo.json

@@ -17,10 +17,11 @@
         }
     ],
     "license": {
-        "id": "General Public License v3 (GPLv3)"
+        "id": "GPL-3.0+"
     },
     "title": "NEOPRENE: Neyman-Scott Process Rainfall Emulator",
     "upload_type": "software",
     "keywords": ["Rainfall emulator", "Neyman-Scott"],
-    "description": "<h1 id=\"neoprene-neyman-scott-process-rainfall-emulator\">NEOPRENE: Neyman-Scott Process Rainfall Emulator</h1><p><a href=\"https://zenodo.org/badge/latestdoi/409946207\"><img src=\"https://zenodo.org/badge/409946207.svg\" alt=\"DOI\" /></a></p><p>The <strong>NEOPRENE</strong> library implements a rectangular pulses model for rainfall emulation based on the Neyman-Scott process. The emulator may be used to generate multi-site synthetic rainfall time series that reproduce observed statistics at different temporal aggregations. It has been designed with rainfall dissaggregation and extreme rainfall analysis in mind.</p><p>The description of the Neyman-Scott Process -or Space-time Neyman-Scott Rectangular Pulses Model- can be found in the <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/doc\">doc folder</a>.</p><p>A paper describing the library has been sent for review to <em>Environmental Modelling &amp; Software</em>.</p><p>Other papers by the authors where -previous incarnations of- the <strong>NEOPRENE</strong> library has been used and the mathematical model has been described are:</p><ul><li>Diez-Sierra, J.; del Jesus, M. Subdaily Rainfall Estimation through Daily Rainfall Downscaling Using Random Forests in Spain. Water <strong>2019</strong>, <em>11</em>, 125. <a href=\"https://doi.org/10.3390/w11010125\">https://doi.org/10.3390/w11010125</a></li><li>del Jesus, M.; Rinaldo, A.; Rodriguez-Iturbe, I. Point rainfall statistics for ecohydrological analyses derived from satellite integrated rainfall measurements. Water Resources Research <strong>2015</strong>, <em>51(4)</em>, 2974-2985. <a href=\"https://doi.org/10.1002/2015WR016935\">https://doi.org/10.1002/2015WR016935</a></li></ul><h2 id=\"contents\">Contents</h2><table><colgroup><col style=\"width: 52%\" /><col style=\"width: 47%\" /></colgroup><thead><tr class=\"header\"><th style=\"text-align: left;\">Directory</th><th style=\"text-align: left;\">Contents</th></tr></thead><tbody><tr class=\"odd\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/NEOPRENE/NSRP\">NSRP</a></td><td style=\"text-align: left;\">Python code to calibrate the NSRPM (Neyman-Scott Rectangular Pulse Model) and simulate single-site synthetic rainfall series.</td></tr><tr class=\"even\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/NEOPRENE/STNSRP\">STNSRP</a></td><td style=\"text-align: left;\">Python code for calibrate the STNSRPM (Space-Time Neyman-Scott Rectangular Pulse Model) and simulate multi-site synthetic rainfall series.</td></tr><tr class=\"odd\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/doc\">doc</a></td><td style=\"text-align: left;\">Description of the model.</td></tr><tr class=\"even\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">notebooks</a></td><td style=\"text-align: left;\">Jupyter notebooks with examples on how to calibrate, simulate and validate a Neyman-Scott model using the library. Examples on how to perform a daily-to-hourly rainfall disaggregation using the synthetic series are also included.</td></tr></tbody></table><h2 id=\"requirements\">Requirements</h2><p>Scripts and (jupyter) notebooks are provided in <a href=\"https://www.python.org/\">Python</a> to ensure reproducibility and reusability of the results. The simplest way to match all these requirements is by using a dedicated <a href=\"https://docs.conda.io\">conda</a> environment, which can be easily installed by issuing:</p><div class=\"sourceCode\" id=\"cb1\"><pre class=\"sourceCode sh\"><code class=\"sourceCode bash\"><span id=\"cb1-1\"><a href=\"#cb1-1\" aria-hidden=\"true\" tabindex=\"-1\"></a><span class=\"ex\">conda</span> create <span class=\"at\">-n</span> NEOPRENE pip jupyter</span><span id=\"cb1-2\"><a href=\"#cb1-2\" aria-hidden=\"true\" tabindex=\"-1\"></a><span class=\"ex\">conda</span> activate NEOPRENE</span><span id=\"cb1-3\"><a href=\"#cb1-3\" aria-hidden=\"true\" tabindex=\"-1\"></a><span class=\"ex\">pip</span> install NEOPRENE</span></code></pre></div><h2 id=\"examples-of-use\">Examples of use</h2><p>Examples of use of the <code>NEOPRENE</code> library are available in the form of <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">jupyter notebooks</a>. To run the examples follow the following steps:</p><ol type=\"1\"><li>Download the folder <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">notebooks</a> from the github repository, or navigate to the folder should you have cloned the repo.</li><li>Open jupyter notebook of Jupyter Lab (type <code>jupyter notebook</code> or <code>jupyter lab</code> in the terminal)</li><li>Open one of the tests available in the <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">notebooks</a> folder with jupyter notebook (e.g. <a href=\"https://github.com/IHCantabria/NEOPRENE/blob/main/notebooks/NSRP_test.ipynb\">NSRP_test.ipynb</a>, <a href=\"https://github.com/IHCantabria/NEOPRENE/blob/main/notebooks/STNSRP_test.ipynb\">STNSRP_test.ipynb</a>)</li></ol><h2 id=\"errata-and-problem-reporting\">Errata and problem reporting</h2><p>To report an issue with the library, please fill a GitHub issue.</p><h2 id=\"contributors\">Contributors</h2><p>The original version of the library was developed by:</p><ul><li>Javier Diez-Sierra</li><li>Salvador Navas</li><li>Manuel del Jesus</li></ul><h2 id=\"license\">License</h2><p>Copyright 2021 Instituto de Hidráulica Ambiental “IHCantabria”. Universidad de Cantabria.</p><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p><p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href=\"https://www.gnu.org/licenses/\" class=\"uri\">https://www.gnu.org/licenses/</a>.</p>"
+    "description":
+"<h1 id=\"neoprene-neyman-scott-process-rainfall-emulator\">NEOPRENE: Neyman-Scott Process Rainfall Emulator</h1><p><a href=\"https://zenodo.org/badge/latestdoi/409946207\"><img src=\"https://zenodo.org/badge/409946207.svg\" alt=\"DOI\" /></a></p><p>The <strong>NEOPRENE</strong> library implements a rectangular pulses model for rainfall emulation based on the Neyman-Scott process. The emulator may be used to generate multi-site synthetic rainfall time series that reproduce observed statistics at different temporal aggregations. It has been designed with rainfall dissaggregation and extreme rainfall analysis in mind.</p><p>The description of the Neyman-Scott Process -or Space-time Neyman-Scott Rectangular Pulses Model- can be found in the <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/doc\">doc folder</a>.</p><p>A paper describing the library has been sent for review to <em>Environmental Modelling &amp; Software</em>.</p><p>Other papers by the authors where -previous incarnations of- the <strong>NEOPRENE</strong> library has been used and the mathematical model has been described are:</p><ul><li>Diez-Sierra, J.; del Jesus, M. Subdaily Rainfall Estimation through Daily Rainfall Downscaling Using Random Forests in Spain. Water <strong>2019</strong>, <em>11</em>, 125. <a href=\"https://doi.org/10.3390/w11010125\">https://doi.org/10.3390/w11010125</a></li><li>del Jesus, M.; Rinaldo, A.; Rodriguez-Iturbe, I. Point rainfall statistics for ecohydrological analyses derived from satellite integrated rainfall measurements. Water Resources Research <strong>2015</strong>, <em>51(4)</em>, 2974-2985. <a href=\"https://doi.org/10.1002/2015WR016935\">https://doi.org/10.1002/2015WR016935</a></li></ul><h2 id=\"test-the-library\">Test the library</h2><p>If you are curious about how the library works or what it can do, I invite you to go to the <strong>Releases</strong> section of this webpage (on the right-hand side of the page) and download the executable file <strong>NEOPRENE-Setup</strong> for your operative system. This executable file will check if Jupyterlab Desktop is installed in your computer. If it is not, it will download the installation program for you to install Jupyterlab. After Jupyterlab is installed, <strong>NEOPRENE-Setup</strong> will launch the example notebooks for you. Then you can test the library and check its functionality in action.</p><h2 id=\"contents\">Contents</h2><table><colgroup><col style=\"width: 52%\" /><col style=\"width: 47%\" /></colgroup><thead><tr class=\"header\"><th style=\"text-align: left;\">Directory</th><th style=\"text-align: left;\">Contents</th></tr></thead><tbody><tr class=\"odd\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/NEOPRENE/NSRP\">NSRP</a></td><td style=\"text-align: left;\">Python code to calibrate the NSRPM (Neyman-Scott Rectangular Pulse Model) and simulate single-site synthetic rainfall series.</td></tr><tr class=\"even\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/NEOPRENE/STNSRP\">STNSRP</a></td><td style=\"text-align: left;\">Python code for calibrate the STNSRPM (Space-Time Neyman-Scott Rectangular Pulse Model) and simulate multi-site synthetic rainfall series.</td></tr><tr class=\"odd\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/doc\">doc</a></td><td style=\"text-align: left;\">Description of the model.</td></tr><tr class=\"even\"><td style=\"text-align: left;\"><a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">notebooks</a></td><td style=\"text-align: left;\">Jupyter notebooks with examples on how to calibrate, simulate and validate a Neyman-Scott model using the library. Examples on how to perform a daily-to-hourly rainfall disaggregation using the synthetic series are also included.</td></tr></tbody></table><h2 id=\"requirements\">Requirements</h2><p>Scripts and (jupyter) notebooks are provided in <a href=\"https://www.python.org/\">Python</a> to ensure reproducibility and reusability of the results. The simplest way to match all these requirements is by using a dedicated <a href=\"https://docs.conda.io\">conda</a> environment, which can be easily installed by issuing:</p><div class=\"sourceCode\" id=\"cb1\"><pre class=\"sourceCode sh\"><code class=\"sourceCode bash\"><span id=\"cb1-1\"><a href=\"#cb1-1\" aria-hidden=\"true\" tabindex=\"-1\"></a><span class=\"ex\">conda</span> create <span class=\"at\">-n</span> NEOPRENE pip jupyter</span><span id=\"cb1-2\"><a href=\"#cb1-2\" aria-hidden=\"true\" tabindex=\"-1\"></a><span class=\"ex\">conda</span> activate NEOPRENE</span><span id=\"cb1-3\"><a href=\"#cb1-3\" aria-hidden=\"true\" tabindex=\"-1\"></a><span class=\"ex\">pip</span> install NEOPRENE</span></code></pre></div><h2 id=\"examples-of-use\">Examples of use</h2><p>Examples of use of the <code>NEOPRENE</code> library are available in the form of <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">jupyter notebooks</a>. To run the examples follow the following steps:</p><ol type=\"1\"><li>Download the folder <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">notebooks</a> from the github repository, or navigate to the folder should you have cloned the repo.</li><li>Open jupyter notebook of Jupyter Lab (type <code>jupyter notebook</code> or <code>jupyter lab</code> in the terminal)</li><li>Open one of the tests available in the <a href=\"https://github.com/IHCantabria/NEOPRENE/tree/main/notebooks\">notebooks</a> folder with jupyter notebook (e.g. <a href=\"https://github.com/IHCantabria/NEOPRENE/blob/main/notebooks/NSRP_test.ipynb\">NSRP_test.ipynb</a>, <a href=\"https://github.com/IHCantabria/NEOPRENE/blob/main/notebooks/STNSRP_test.ipynb\">STNSRP_test.ipynb</a>)</li></ol><h2 id=\"errata-and-problem-reporting\">Errata and problem reporting</h2><p>To report an issue with the library, please fill a GitHub issue.</p><h2 id=\"contributors\">Contributors</h2><p>The original version of the library was developed by:</p><ul><li>Javier Diez-Sierra</li><li>Salvador Navas</li><li>Manuel del Jesus</li></ul><h2 id=\"license\">License</h2><p>Copyright 2021 Instituto de Hidráulica Ambiental “IHCantabria”. Universidad de Cantabria.</p><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p><p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href=\"https://www.gnu.org/licenses/\" class=\"uri\">https://www.gnu.org/licenses/</a>.</p>"
 }

CITATION.cff

@@ -14,7 +14,7 @@ authors:
     orcid: "https://orcid.org/0000-0003-0703-8960"
     affiliation: "Environmental Hydraulics Institute \"IHCantabria\". Universidad de Cantabria. Santander, Spain."
 title: "NEOPRENE: Neyman-Scott Process Rainfall Emulator"
-version: "0.99.1"
+version: "1.0.0"
 license: GPLv3
 repository-code: "https://github.com/IHCantabria/NEOPRENE"
 doi: 10.5281/zenodo.5549811 

setup.py

@@ -9,7 +9,7 @@
 setup(  name='NEOPRENE',
         packages = find_packages(),
         license = "GPLv3",
-        version='0.99.1',
+        version='1.0.0',
         description='🌎 Scripts and information to synthetic generation of precipitation based on Point Processes.',
         long_description=long_description,
         long_description_content_type='text/markdown',

utils/Zenodo_File_Template

@@ -17,7 +17,7 @@
         }
     ],
     "license": {
-        "id": "General Public License v3 (GPLv3)"
+        "id": "GPL-3.0+"
     },
     "title": "NEOPRENE: Neyman-Scott Process Rainfall Emulator",
     "upload_type": "software",