Skip to content

Installation

Quick Start

  1. Download and install anaconda

    Warning

    Anaconda requires a license if you work at a company with >200 employees (academic instituitions exlcuded). If this applies to you, download miniforge instead, which is free & open-source for everyone. The conda commands below will be the same.

  2. Set up a conda environment, install Simmate within it, and activate it

    conda create -n my_env -c conda-forge python=3.11 simmate
    conda activate my_env
    

  3. Run the help command to verify the installation

    simmate --help
    

  4. For first-time setup, initialize your local database (SQLite)

    simmate database reset
    

  5. Start the local dev server and keep this command running

    simmate run-server
    

  6. Visit http://127.0.0.1:8000/ to access your local server