Installation¶

Version: 0.9.8.1

Installation requires system prerequisites, Python environment setup, and dependency installation. This guide covers both standard user and developer installations.

System Prerequisites¶

Git: Required for repository access.
C++ Build Tools: The roughpy library provides pre-compiled wheels for most platforms, but build tools may be required:
- Linux (Debian/Ubuntu):
```
sudo apt-get update
sudo apt-get install build-essential python3-dev
```
- macOS:
```
xcode-select --install
```
- Windows: Install “Microsoft C++ Build Tools” via Visual Studio with “Desktop development with C++” workload.

Python Prerequisites¶

Python: Version 3.10+ required.
pip: Ensure up to date (included with Python).

Installation Steps¶

Clone the Repository: CreativeDynamics is a private repository requiring a Personal Access Token (PAT).

Create a GitHub PAT:
- Navigate to: GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
- Generate token with repo scope
- Copy the token immediately
Clone:
```
git clone https://github.com/tandpds/CreativeDynamics.git
cd CreativeDynamics
```
Use your PAT when prompted for password.

Create and Activate Virtual Environment:

python -m venv .venv

# Linux/macOS:
source .venv/bin/activate
# Windows (Command Prompt):
# .\venv\Scripts\activate.bat
# Windows (PowerShell):
# .\venv\Scripts\Activate.ps1

Install Dependencies:
```
pip install --upgrade pip
pip install .
```
Installs core dependencies defined in pyproject.toml including pandas, numpy, fastapi, and roughpy.

Optional Extras¶

CreativeDynamics provides optional dependency groups for different use cases:

# With AI-generated narrative reports (requires OpenAI API key)
pip install ".[ai]"

# Just testing dependencies
pip install ".[test]"

# Just documentation dependencies
pip install ".[docs]"

# For development (includes testing, docs, linting, and AI)
pip install ".[dev]"

Developer Installation¶

For contributors, complete the standard installation then:

Install in Editable Mode with Dev Dependencies:
```
pip install -e ".[dev]"
```
Enables immediate reflection of source code changes and installs all development tools.
Set Up Pre-commit Hooks:
```
pre-commit install
```
Automatically runs formatting (Black) and linting (Flake8) on commit.

Next Steps¶

Usage Guide
Run examples in examples/ directory
Review API reference for module details