https://github.com/aeturrell/cookiecutter-research-project
A cookiecutter for creating research projects
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.0%) to scientific vocabulary
Keywords
Repository
A cookiecutter for creating research projects
Basic Info
- Host: GitHub
- Owner: aeturrell
- Language: TeX
- Default Branch: main
- Size: 355 KB
Statistics
- Stars: 18
- Watchers: 2
- Forks: 5
- Open Issues: 2
- Releases: 0
Topics
Metadata Files
README.md
Cookiecutter Research Project
A template for a modern, fully featured and efficient research project.
Setup
Prerequisites:
- the Python package manager uv
cookiecutterpackage (link here)- an installation of Quarto
- an installation of LaTeX
How to use this template
To install cookiecutter, which will help you populate the template with details like your project's name, run
bash
uv tool install cookiecutter
To create a new project folder based on this cookie cutter:
bash
uv tool run cookiecutter https://github.com/aeturrell/cookie-cutter-research-project.git
The new project folder will appear within the folder you ran the command in.
Working on your project
This assumes you are in the project root.
First, run uv sync to create the Python environment (it installs into .venv)
To create the paper, use make paper.
To create the slides, use make slides.
You might also like
Looking for further reproducible research inspiration? Check out this worked example of a reproducible research project.
Top tips
For Quarto documents (paper and slides), the root is the project root. To properly reference markdown images in another folder using project root, begin with a forward slash, eg:
markdown
or, for latex
markdown
{{< include /outputs/equation.tex >}}
Owner
- Login: aeturrell
- Kind: user
- Website: www.aeturrell.com
- Repositories: 9
- Profile: https://github.com/aeturrell
GitHub Events
Total
- Issues event: 3
- Watch event: 4
- Delete event: 1
- Issue comment event: 1
- Push event: 1
- Fork event: 1
Last Year
- Issues event: 3
- Watch event: 4
- Delete event: 1
- Issue comment event: 1
- Push event: 1
- Fork event: 1