Skip to content

Commit

Permalink
Zenodo metadata file modified
Browse files Browse the repository at this point in the history
On branch main
Your branch is up to date with 'origin/main'.

Changes to be committed:
	modified:   .zenodo.json
  • Loading branch information
manueldeljesus committed Oct 6, 2021
1 parent a0e1feb commit 1761977
Showing 1 changed file with 72 additions and 15 deletions.
87 changes: 72 additions & 15 deletions .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,78 @@
"orcid": "0000-0003-0703-8960"
}
],
"license": "Apache-2.0",
"license": {
"id": "Apache-2.0"
},
"title": "NEOPRENE: Neyman-Scott Process Rainfall Emulator",
"upload_type": "software",
"description": "NEOPRENE library to emulate and synthetically produce time series of rainfall.",
"keywords": ["Rainfall emulator", "Neyman-Scott"],
"related_identifiers": [
{
"scheme": "url",
"identifier": "https://github.com/IHCantabria/NEOPRENE/tree/v0.0.13",
"relation": "isSupplementTo"
},
{
"scheme": "doi",
"identifier": "10.5281/zenodo.5549810",
"relation": "isVersionOf"
}
]
}
"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 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 Spatio-temporal 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 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 (Spatio-Temporal Neyman-Scott Rectangular Pulse Model) and simulate multisite rainfall series (in progress).</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 is 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>)</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 Díez-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>Licensed under the Apache License, Version 2.0 (the “License”); you may not use this library except in compliance with the License. You may obtain a copy of the License at</p>
<pre><code>http://www.apache.org/licenses/LICENSE-2.0</code></pre>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
"
}

0 comments on commit 1761977

Please sign in to comment.