CRESP Templates

This repository contains templates for the CRESP tool (Computational Research Environment Standardization Protocol).

Overview

CRESP is a tool for creating reproducible computational research environments. This repository contains the templates used by CRESP to initialize projects in different languages and frameworks.

The templates ensure that projects follow best practices for reproducibility, including:

• Standardized project structure
• Environment isolation and dependency management
• Proper documentation
• Testing frameworks
• Jupyter notebook integration
• Version control configuration

Available Templates

• python - Templates for Python projects
  • Default template uses Conda for environment management and Poetry for package management
  • Also supports usage directly with Cookiecutter

Multiple Usage Methods

CRESP templates can be used in multiple ways:

1. Via CRESP Tool: The primary way these templates are meant to be used

   pip install cresp
   cresp new python my-project

2. Direct Cookiecutter Usage: Our Python template also works as a standalone Cookiecutter template

   pip install cookiecutter
   cookiecutter https://github.com/wisupai/cresp-templates --directory="templates/python/default"

For Template Developers

Adding New Templates

To add a new language or framework template:

1. Create a new directory under templates/
2. Create a default template subdirectory (e.g., templates/newlang/default/)
3. Include all necessary template files
4. Add a README.md in the language directory explaining the template

Template Structure

Each template should include:

• Documentation
• Environment configuration files
• Project structure with standard directories
• Template README.md with usage instructions
• Placeholder variables (using %PLACEHOLDER% format)

License

This project is licensed under the MIT License - see the LICENSE file for details.