Skip to content

Getting Started

New to git?

GitKraken lets you fork, clone, branch, and commit without the command line. Their 6-minute intro video covers the basics. Students and teachers get GitKraken Pro and GitHub Pro free through GitHub Education.

  1. Fork and clone jacksund/simmate:

    • GitKraken: fork the repo on GitHub, then clone your fork (yourname/simmate) in GitKraken
    • GitHub CLI: gh repo fork jacksund/simmate --clone (also adds jacksund/simmate as the upstream remote)

  2. Install uv, then create the virtual environment and install all dependencies: 

    cd simmate
uv sync --all-extras

  3. Activate the virtual environment:

    source .venv/bin/activate

    .venv\Scripts\activate

  4. Start from a fresh, empty database: 

    simmate database reset --confirm-delete --no-use-prebuilt

  5. Make sure the tests pass: 

    simmate dev test

  6. Continue to Creating & submitting changes for linting, testing, and opening a pull request.