README.md

Paper Title

By A. A. Author¹, B. B. Author¹, & C. C. Author²

¹Department, Organization, City, State, Country

²Department, Organization, City, State, Country

Status: This manuscript has been submitted for publication at <JOURNAL>. The <PAPER> was published in <JOURNAL> in <MONTH, YEAR>. <SUPPORTING_INFORMATION> is also available. We welcome any comments, questions, or suggestions. Please email your feedback to <MAIN_AUTHOR> (<EMAIL>).

Abstract: Insert abstract text here.

Project Organization

├── LICENSE.md         <- License for code
│
├── README.md          <- Top-level information on this code base
│
├── data/
│   ├── external/      <- Data from third party sources
│   ├── interim/       <- Intermediate data that has been transformed
│   ├── processed/     <- Final analysis-ready data
│   └── raw/           <- Original immutable data
│
├── figs/              <- Generated figures/graphics 
│
├── notebooks/         <- Jupyter notebooks for data analysis/visualizations
│
├── scripts/           <- Source code for use in this project     
│
└── environment.yml    <- File for reproducing the analysis environment

Acknowledgements

The analysis for this work has been performed on <HPC>. This research was funded by <GRANTOR>.<NAME> provided helpful feedback on the first draft. Thanks to our colleagues at <ORGANIZATION> for their continued support.

---

This template is based on the cookiecutter data science project template.