From 17619779f809cc16e5ee208228508c3ee66f28da Mon Sep 17 00:00:00 2001 From: Manuel del Jesus Date: Wed, 6 Oct 2021 08:58:01 +0200 Subject: [PATCH] Zenodo metadata file modified On branch main Your branch is up to date with 'origin/main'. Changes to be committed: modified: .zenodo.json --- .zenodo.json | 87 +++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 72 insertions(+), 15 deletions(-) diff --git a/.zenodo.json b/.zenodo.json index b5381da..e6feec5 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -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" - } - ] -} \ No newline at end of file + "description": "

NEOPRENE: Neyman-Scott Process Rainfall Emulator

+

\"DOI\"

+

The NEOPRENE 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.

+

The description of the Neyman-Scott Process -or Spatio-temporal Neyman-Scott Rectangular Pulses Model- can be found in the doc folder.

+

A paper describing the library has been sent for review to Environmental Modelling & Software.

+

Other papers by the authors where -previous incarnations of- the NEOPRENE library has been used and the mathematical model has been described are:

+ +

Contents

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DirectoryContents
NSRPPython code to calibrate the NSRPM (Neyman-Scott Rectangular Pulse Model) and simulate synthetic rainfall series.
STNSRPPython code for calibrate the STNSRPM (Spatio-Temporal Neyman-Scott Rectangular Pulse Model) and simulate multisite rainfall series (in progress).
docDescription of the model.
notebooksJupyter 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.
+

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:

+ 
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:

+
    +
  1. Download the folder notebooks from the github repository, or navigate to the folder should you have cloned the repo.
    2. +
  2. Open jupyter notebook of Jupyter Lab (type jupyter notebook or jupyter lab in the terminal)
    3. +
  3. Open one of the tests available in the notebooks folder with jupyter notebook (e.g. NSRP_test.ipynb)
    4. +
+

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:

+ +

License

+

Copyright 2021 Instituto de Hidráulica Ambiental “IHCantabria”. Universidad de Cantabria.

+

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

+ 
http://www.apache.org/licenses/LICENSE-2.0
+

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.

+ " +}