Skip to content

README.md

Latest commit

 

History

History
47 lines (33 loc) · 1.3 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.3 KB

Research Project Template

This repository contains a standardized structure for research projects, designed to promote reproducibility and good scientific practices.

Project Structure

research-project/
├── experiments/          # Individual experiments
├── data/                # Project-wide data
├── src/                 # Common source code
├── manuscripts/         # Papers and publications
├── docs/               # Documentation
└── references/         # Literature and references

Getting Started

  1. Clone this repository
  2. Create and activate the environment: 
    conda env create -f environment.yml
conda activate research-env
  3. Follow the contribution guidelines in CONTRIBUTING.md

Creating a New Experiment

  1. Copy the experiments/_template folder to create a new experiment
  2. Update the experiment's README.md with specific details
  3. Register the experiment in experiments/experiment_registry.md

cp -r experiments/_template experiments/experiment_001

Dependencies

  • Python 3.8+
  • Conda for environment management
  • Git for version control

License

See LICENSE.md for terms of use and sharing.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.