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.

Install from PyPI#

This is the easiest way to install AutoEmulate.

Currently, because we are in active development, you have to install the development version from GitHub:

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

Install using Poetry#

If you are a code contributor, you can also use Poetry

$ git clone https://github.com/alan-turing-institute/autoemulate.git

Navigate into the directory:

$ cd autoemulate

Set up poetry:

$ poetry install

Enter the poetry shell:

$ poetry shell