Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 15 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary
Repository
Neyman-Scott Process Rainfall Emulator library
Basic Info
- Host: GitHub
- Owner: IHCantabria
- License: gpl-3.0
- Language: Jupyter Notebook
- Default Branch: main
- Size: 45.7 MB
Statistics
- Stars: 17
- Watchers: 6
- Forks: 6
- Open Issues: 4
- Releases: 8
Metadata Files
README.md
NEOPRENE: Neyman-Scott Process Rainfall Emulator
The NEOPRENE 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.
The description of the Neyman-Scott Process -or Space-time Neyman-Scott Rectangular Pulses Model- can be found in the doc folder.
A paper describing and testing the library has been published in the scientific journal Geoscientific Model Development. The paper can be cited as:
- Diez-Sierra, J., Navas, S., and del Jesus, M.: NEOPRENE v1.0.1: a Python library for generating spatial rainfall based on the Neyman–Scott process, Geosci. Model Dev., 16, 5035–5048, https://doi.org/10.5194/gmd-16-5035-2023, 2023.
Other papers by the authors where -previous incarnations of- the NEOPRENE library has been used and the mathematical model has been described are:
- Diez-Sierra, J.; del Jesus, M. Subdaily Rainfall Estimation through Daily Rainfall Downscaling Using Random Forests in Spain. Water 2019, 11, 125. https://doi.org/10.3390/w11010125
- del Jesus, M.; Rinaldo, A.; Rodriguez-Iturbe, I. Point rainfall statistics for ecohydrological analyses derived from satellite integrated rainfall measurements. Water Resources Research 2015, 51(4), 2974-2985. https://doi.org/10.1002/2015WR016935
Test the library
If you are curious about how the library works or what it can do, I invite you to go to the Releases section of this webpage (on the right-hand side of the page) and download the executable file NEOPRENE-Setup 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, NEOPRENE-Setup will launch the example notebooks for you. Then you can test the library and check its functionality in action.
Contents
| Directory | Contents | | :-------- | :------- | | NSRP | Python code to calibrate the NSRPM (Neyman-Scott Rectangular Pulse Model) and simulate single-site synthetic rainfall series. | STNSRP | Python code for calibrate the STNSRPM (Space-Time Neyman-Scott Rectangular Pulse Model) and simulate multi-site synthetic rainfall series. | doc | Description of the model. | notebooks | 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.
Requirements
Scripts and (jupyter) notebooks are provided in Python to ensure reproducibility and reusability of the results. The simplest way to match all these requirements is by using a dedicated conda environment, which can be easily installed by issuing:
sh
conda create -n NEOPRENE pip jupyter
conda activate NEOPRENE
pip install NEOPRENE
Examples of use
Examples of use of the NEOPRENE library are available in the form of jupyter notebooks. To run the examples follow the following steps:
- Download the folder notebooks from the github repository, or navigate to the folder should you have cloned the repo.
- Open jupyter notebook of Jupyter Lab (type
jupyter notebookorjupyter labin the terminal) - Open one of the tests available in the notebooks folder with jupyter notebook (e.g. NSRP_test.ipynb, STNSRP_test.ipynb)
Errata and problem reporting
To report an issue with the library, please fill a GitHub issue.
Contributors
The original version of the library was developed by:
- Javier Diez-Sierra
- Salvador Navas
- Manuel del Jesus
License
Copyright 2021 Instituto de Hidráulica Ambiental "IHCantabria". Universidad de Cantabria.
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.
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.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Owner
- Name: IHCantabria
- Login: IHCantabria
- Kind: organization
- Email: info@ihcantabria.com
- Location: Spain
- Website: http://www.ihcantabria.com
- Twitter: ihcantabria
- Repositories: 8
- Profile: https://github.com/IHCantabria
Site principal de IHCantabria
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Diez-Sierra"
given-names: Javier
orcid: "https://orcid.org/0000-0001-9053-2542"
affiliation: "Santander Meteorology Group, Dept. Applied Mathematics and Computer Science, Universidad de Cantabria, Santander, Spain"
- family-names: Navas
given-names: Salvador
orcid: "https://orcid.org/0000-0001-7439-1743"
affiliation: "Environmental Hydraulics Institute \"IHCantabria\". Universidad de Cantabria. Santander, Spain."
- family-names: "del Jesus"
given-names: Manuel
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: "1.0.1"
license: GPLv3
repository-code: "https://github.com/IHCantabria/NEOPRENE"
doi: 10.5281/zenodo.5549811
date-released: 2021-10-04
GitHub Events
Total
- Watch event: 4
- Push event: 2
- Fork event: 1
Last Year
- Watch event: 4
- Push event: 2
- Fork event: 1
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 126
- Total Committers: 7
- Avg Commits per committer: 18.0
- Development Distribution Score (DDS): 0.468
Top Committers
| Name | Commits | |
|---|---|---|
| Salvador Navas | 6****1@u****m | 67 |
| Javier Diez-Sierra | 3****a@u****m | 23 |
| Manuel del Jesus | m****e@g****m | 16 |
| JavierDiezSierra | j****z@u****s | 15 |
| JavierDiezSierra | d****j@u****s | 3 |
| navass11 | n****s@u****s | 1 |
| Manuel | m****s@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 20
- Total pull requests: 6
- Average time to close issues: 2 months
- Average time to close pull requests: 1 minute
- Total issue authors: 5
- Total pull request authors: 2
- Average comments per issue: 2.25
- Average comments per pull request: 0.0
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 1 minute
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- JavierDiezSierra (13)
- manueldeljesus (4)
- sabahparvaze (1)
- monicasantamaria (1)
- Hiatus12 (1)
Pull Request Authors
- navass11 (7)
- thecrazyphysicist (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 47 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 13
- Total maintainers: 2
pypi.org: neoprene
🌎 Scripts and information to synthetic generation of precipitation based on Point Processes.
- Homepage: https://github.com/IHCantabria/NEOPRENE
- Documentation: https://neoprene.readthedocs.io/
- License: GPLv3
-
Latest release: 1.1.0
published over 1 year ago
Rankings
Maintainers (2)
Dependencies
- datetime *
- haversine *
- matplotlib *
- numpy *
- pandas *
- pyshp *
- pyyaml *
- scipy *
- shapely *
- tqdm *