Installation

Follow the steps below to install the simdesign package.

Note

Python 3.12 is required. Ensure that correct version is installed.

python --version  # should be 3.12.x

Create a Virtual Environment (Recommended)

Create a virtual environment to manage dependencies:

python -m venv .venv

Activate the virtual environment:

.venv\Scripts\activate     # On Windows
source .venv/bin/activate  # Linux / macOS

Option 1: Install via PyPI

Open the terminal and simply run:

pip install simdesign

Option 2: Install from Source

Clone the repository:

git clone https://github.com/builtenvdata/simulated-design.git
cd simulated-design

Install the dependencies using requirements file:

pip install -r requirements.txt

Install the simdesign package:

pip install .

Alternatively, to install in editable mode (useful for development):

pip install -e .