Setup
This page should let a new contributor reproduce the project environment.
Requirements
- OS:
- Python version:
- Node version:
- External tools:
- Hardware requirements:
- Licenses:
Clone the repository
git clone REPOSITORY_URL
cd REPOSITORY_NAME
Environment Setup
# Example
conda create -n PROJECT_NAME python=3.11
conda activate PROJECT_NAME
pip install -r requirements.txt
Run a minimal text
# Example
python -m pytest
Build the documentation site
nvm use
npm ci
npm run start
Common setup problems
| Problem | Likely cause | Solution |
|---|---|---|
| Example problem | Explanation | Action |