Quick Start Guide¶

Welcome to the CAPE Replication Project! This guide will help you get up and running as quickly as possible.

1. Clone the Repository¶

git clone https://github.com/your-username/cape-replication-project.git
cd cape-replication-project

2. Set Up the Environment¶

Recommended: Using Conda

conda env create -f scripts/environment.yml -n chafs_b
conda activate chafs_b

Alternative: Using pip

python -m venv cape_env
source cape_env/bin/activate  # On Windows: cape_env\Scripts\activate
pip install -r requirements-docs.txt

3. Configure Data Paths¶

Edit config/config.json to set your data directories and file paths.

4. Prepare Data Files¶

Place the required data files in your input directory (see Installation Guide for details).

5. Run a Test¶

cd scripts/processing
python cape_preprocessing.py --start-from 3

6. Explore the Project¶

• See the Installation Guide for detailed setup instructions.
• Check the User Guide for more information.

If you encounter issues, see the Troubleshooting section in the Installation Guide or open an issue on GitHub.