Developer install#

These instructions will take you through the minimal steps required to get a dev environment setup, so you can run the tests locally.

Clone the repository#

First clone the repository locally using Git:

$ git clone git://github.com/DiamondLightSource/dodal.git

You can choose to either develop on the host machine using a venv (which requires python 3.8 or later) or to run in a container under VSCode

Local virtualenv

$ cd dodal
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e .[dev]

VSCode devcontainer

$ code dodal
# Click on 'Reopen in Container' when prompted
# Open a new terminal

Note

See the epics-containers documentation for more complex use cases, such as integration with podman.

To see a graph of the python package dependency tree type:

$ pipdeptree

Now you have a development environment you can run the tests in a terminal:

$ tox -p

This will run in parallel the following checks: