Development Installation

Development sources

Microscope development sources are available on GitHub. To install the current development version of Microscope:

git clone https://github.com/MicronOxford/microscope.git
pip install microscope/

Also consider using editable mode if you plan to make changes to the project:

pip install --editable microscope/

Multiple Microscope versions

Python package system will not by default handle multiple versions of a package. If installing from development, beware to not overwrite a previous installation. A typical approach to address this issue is to use virtual environments.

Un-merged features

Some features are still in development and have not been merged in the main branch. To try such features, you will need to know the branch name and the repository where such feature is being developed. For example, to try Toshiki Kubo’s implementation of the Mirao52e deformable mirror:

git remote add toshiki https://github.com/toshikikubo/microscope.git
git fetch toshiki
git checkout toshiki/mirao52e
pip install ./