Getting Started

Welcome to DisruptSC! This section will help you get up and running with the model quickly.

Prerequisites

Before you begin, make sure you have:

• Python 3.10 or 3.11 installed
• Git for repository management
• Access to input data (see Data Setup)

Setup Process

Follow these steps to get DisruptSC running on your system:

1. Installation - Set up the environment and dependencies
2. Data Setup - Configure input data sources
3. Quick Start - Run your first simulation
4. Input Validation - Verify your data is correctly formatted

What's Next?

After completing the setup:

• Explore the User Guide for detailed usage instructions
• Learn more about Parameters to customize your simulations
• Read about the Architecture to understand how the model works

Common Issues

Environment setup problems

If you encounter issues with conda environment creation, try:

# Clear conda cache
conda clean --all

# Create environment with explicit solver
conda env create -f dsc-environment.yml --solver=libmamba

Data path not found

Make sure your data path is correctly set:

# Check if environment variable is set
echo $DISRUPT_SC_DATA_PATH

# Or verify data folder exists
ls -la data/

Import errors when running

Ensure you've installed the package in development mode:

conda activate dsc
pip install -e .