Cookiecutter Template for RDM-Examples

This cookiecutter template automatically generates the general file structure for a new CADET-RDM-Example. Please refer to https://github.com/cookiecutter/cookiecutter for additional information.

---

Authors

• Katharina Paul
• Ronald Jäpel
• Hannah Lanzrath

---

Using the cookiecutter template

1. Clone this repository.

2. Set up the environment using the cookiecutter_environment.yml file.

3. Navigate to the desired location of your new Example.

4. Run this command:

   cookiecutter /path/to/cloned/cookiecutter-repository/

5. Enter your input to all upcoming questions. Click Enter to assign the default values given in (). Following this, the file structure will be automatically generated.

6. Run this CADET-RDM command to add the remaining files and complete the RDM-Example file structure:

   rdm init

7. Add git remote origins for project repository and output repository

8. Run the following CADET-RDM commands in the directory of the project repository to automatically stage and push all changes within the project and output repository:

   rdm check

   rdm push