spam: Title of your study
The intention is to publish relevant data. This includes (when applicable):
- Raw data used to produce Figures
- Experimental data
- Simulation Input and Output
- Algorithms (software, scripts)
In essence, this *Open Data* approach will allow **reproducibility** and an **easy analysis by another research group**.
Contributions
-------------
* Author #1 did contribute to
* Author #2 did contribute to
Licensing
---------
Pick on of the following [Creative Commons (CC) licenses](https://creativecommons.org/share-your-work/cclicenses/?utm_source=chatgpt.com) :
- CC0 1.0 (Public Domain Dedication) — no rights reserved; unrestricted reuse
- CC BY 4.0 — attribution required
- CC BY-SA 4.0 — attribution + share alike
- CC BY-ND 4.0 — attribution + no derivatives
- CC BY-NC 4.0 — attribution + non-commercial
- CC BY-NC-SA 4.0 — attribution + non-commercial + share alike
- CC BY-NC-ND 4.0 — attribution + non-commercial + no derivatives
Data collection: period and details
-----------------------------------
* From XXX to XXX, ...
Funding sources
---------------
* Add the funding sources
Data structure and information
------------------------------
* Here the authors are expected to provide a full description of the directories and files
with a consise description. Provide one **README.md** file per directory to help
navigation through the data
For instance it could be:
+ Folder/files structure:
+ `Case 1/` - folder containing results for case 1
+ `README.md` - Description
+ `Case1_EXP_*.csv` - experimental data files
+ `Case1_SIM_INPUT*.inp` - simulation input
+ `Case1_SIM_OUTPUT*.csv` - simulation output
+ `Case2/` - folder containing results for case 2
+ `README.md` - Description
+ `Case2_EXP_*.csv` - experimental data files
+ `Case2_SIM_*.csv` - simulation output
+ `PlotScripts/` - folder containing plotting scripts if any
+ `README.md` - Description of the plotting scripts
+ `plot_fig1-10.py` - python script plotting figure 1-10
+ `plot_fig10-20.py` - python script plotting figure 1-20
Dependencies
------------
* Please provide, as much as possible, the dependencies to reproduce your results. The information should include the version of software (`.lock` files)
- Python: `requirements.txt`
- OS-packages: `pkg.txt`
- spack: `spack.yaml` and `spack.lock`
Workflows
---------
In order to allow collaborators to reproduce results you should provide a workflow description with one of these:
- bash or python script (reproduce.sh|py)
- Makefile
- Snakemake