Installation instructions

Installation instructions#

AutoEmulate is a Python package that can be installed in a number of ways. In this section we will describe the main ways to install the package.

Prerequisites#

Python Version: AutoEmulate requires Python >=3.10 and <3.13.

Install from GitHub#

This is the easiest way to install AutoEmulate.

Currently, because we are in active development, it’s recommended to install the development version from GitHub:

pip install git+https://github.com/alan-turing-institute/autoemulate.git

Install from PyPI#

To get the latest release from PyPI:

pip install autoemulate

Install using Poetry#

If you’d like to contribute to AutoEmulate, you can install the package using Poetry.

  • Ensure you have poetry installed. If not, install it following the official instructions. This has been most recently tested with Poetry version 2.1.

  • Fork the repository on GitHub by clicking the “Fork” button at the top right of the AutoEmulate repository

  • Clone your forked repository:

git clone https://github.com/YOUR-USERNAME/autoemulate.git

Navigate into the directory:

cd autoemulate

Set up poetry:

poetry install

Create a virtual environment:

poetry env activate

Then activate the virtual environment using the command displayed by the previous command. This will be something like:

    source /Users/yourName/Library/Caches/pypoetry/virtualenvs/autoemulate-l4vGdsmY-py3.11/bin/activate
Contents