Template repository for Papers

Repository using Cookiecutter for project templates.

Installation

To use this repository, you need to install cookiecutter. This can be done with pip

python3 -m pip install cookiecutter

For other installation options, see: Cookiecutter installation

You also need to have git installed on your system, see: Download git for more information.

Usage

To use this repository with cookiecutter you can call:

cookiecutter gh:scientificcomputing/generate-paper

and fill out the list of options.

Options for cookiecutter

The following options are available when using the cookiecutter:

1. Full Name: Used in LICENSE and CITATION.cff.
2. github_username: Will be used to to generate links to the documentation
3. project_name: Used as header of documentation and in CITATION.cff
4. repository_name: Name of the repository
5. version: The initial version of the software.
6. open_source_license: Choose a open source license for your code
7. use_pre_commit: Set up pre-commit hooks that will run some checks
8. require_fenics: Does your paper require FEniCS?
9. require_fenicsx: Does your paper require FEniCSx?