Installation¶

Requirements¶

Python Version: 3.9 or higher

Operating Systems: Windows, macOS, Linux

Installation Methods¶

Via pip (Recommended)¶

pip install cognito-sim-engine

Development Installation¶

For developers who want to contribute or modify the engine:

# Clone the repository
git clone https://github.com/yourusername/cognito-sim-engine.git
cd cognito-sim-engine

# Install in development mode
pip install -e .

# Install development dependencies
pip install -e ".[dev]"

From Source¶

# Download the latest release
wget https://github.com/yourusername/cognito-sim-engine/archive/main.zip
unzip main.zip
cd cognito-sim-engine-main

# Install
pip install .

Verify Installation¶

After installation, verify that everything works correctly:

# Check CLI is available
cognito-sim --version

# Run basic tests
python -c "from cognito_sim_engine import CognitiveEngine; print('✓ Installation successful')"

Optional Dependencies¶

For enhanced functionality, consider installing these optional packages:

Visualization¶

pip install matplotlib seaborn plotly

Advanced Analytics¶

pip install pandas numpy scipy

Jupyter Notebook Support¶

pip install jupyter ipywidgets

Documentation Building¶

pip install mkdocs mkdocs-material mkdocstrings

Troubleshooting¶

Common Issues¶

Import Error: If you encounter import errors, ensure you have Python 3.9+ and all dependencies are properly installed.

Memory Warnings: For large simulations, ensure adequate system memory (4GB+ recommended).

Visualization Issues: If matplotlib plots don't display, check your backend configuration:

import matplotlib
matplotlib.use('TkAgg')  # or 'Qt5Agg'

Getting Help¶

Next Steps¶

Once installed, continue to the Quick Start guide to create your first cognitive simulation.