Starting an AMUSE-based project

[rieder]

This is a small, hopefully useful guide for starting an AMUSE project.

First, create the directory of your project and change dir:

mkdir my_project
cd my_project

Then, initialise an empty git repository there.

git init .

Now, create the AMUSE environment you will be using for this project.
Ideally, this environment is unique for this project, meaning that it will not interfere with other projects and that it should be reproducible later.

python -m venv env
. env/bin/activate

Then, create a requirements.txt file, which contains all the Python modules you intend to use - such as amuse-framework, amuse-fi, amuse-seba, but also non-amuse modules like matplotlib and jupyter.

Then install these modules:

pip install -r requirements.txt

and add the requirements.txt file to your repository:

git add requirements.txt
git commit -m "create requirements.txt file"

Now you're ready to start your project! Be sure to add any additional packages you need to requirements.txt, and to commit your changes to git frequently.