Installation

Prerequisites

MiGRIDS Lite needs at least Python 3.12. It is not guaranteed to work with earlier versions of Python. For downloading Python, see here.

Installation

It is highly recommended to create a virtual environment. The recommended virtual environment command is either venv or virtualenv. uv has not been tested. conda is not recommended or supported. Read more about virtual environments here.

Navigate to the directory or folder you want to start your project in. To create the virtual environment, open a terminal and use the command:

python3 -m venv .venv

.venv is the directory and name of the virtual environment, it can be named differently. To start the virtual environment from the current directory, use the appropriate command for the operating system:

Linux/macOS:

. .venv/bin/activate

Windows:

.\.venv\Scripts\activate

The virtual environment must be active to install MiGRIDS Lite. Once activated, the virtual environment name will be at the beginning of the command line like below

Linux/macOS:

(.venv) your_username@your-computer:~/Documents/subdocument_folder$

Windows:

(.venv) PS C:\Users\your_username\Documents\subdocument_folder>

To stop the virtual environment, just use the command deactivate or close the terminal.

Local/Clone Repository Install

Either use

git clone https://github.com/acep-uaf/migrids-lite.git

Or download the repository as a .zip and unzip the file.

Navigate to the top level file, where the pyproject.toml is located. With the virtual environment activated, run the command

pip install .

That will install the dependencies (if they haven't been installed already) and MiGRIDS Lite into the virtual environment.

Python Package Index (PyPI)

Coming soon!