Project title

Give a short description of your project.

todo: add figure

Related publications:

• 1. name1, name2. Fancy Title. Journal's name. (2018), 223: 1409 DOI: https://doi.org/

Table of contents

• Prerequisites
• Installation
• Code repository
• How to run
• Collaborators
• How to cite
• Acknowledgments
• License

Prerequisites

Data [optional]

In case you need data, give a description and where to download.

This example data-set: link to data.

Requirements

Project requires Python 3.7, 3.8, 3.9 or 3.10, and the following packages:

• matplotlib == 2.0.1
• scipy > 0.1.0
• jupyter
• conda
• pip

Installation

Here you describe how to install your software/package.

Example 1: In case you have created a python package: Use the package manager pip to install foobar.

Package on pypi

pip install your_package

Package on conda-forge

conda install your_package

Example 2: Creating an environment.

Create environment:

conda

conda env create -f requiremnts.yml

pip

pip install -r requiremnts.txt

Code repository [optional]

Give short description of the files.

• main.py the main script to run the simulation
• create_figures.py script to generate figures

Give a description of the folder structure

• docs contains documentation
• data contains data-set
• figures contains output figures

How to run

Describe how to run/use your project/software/package...

Example 1

1. Preparations Change configuration in config.conf

2. Run simulation python simulate.py

Example 2

import package

# returns 'words'
package.pluralize('word')

# returns 'geese'
package.pluralize('goose')

# returns 'phenomenon'
package.singularize('phenomena')

Collaborators

Name all collaborators for the project.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Acknowledgments

Put in acknowledgments.

How to cite

Describe how to cite your work.

License

MIT