22HLT01 QUMPHY Software Repository
Project Overview
You can find any information about the 22HLT01 QUMPHY project on our project website: www.qumphy.ptb.de. Also we advise you to take a look at the qumphy software repository and all the other resources provided by the QUMPHY group. If you are interested, you could take a look at the software documentation as well.
Installation
First clone the repository to your local machine
git clone git@gitlab.com:qumphy/qumphy-software.git
And enter the repository
cd qumphy-software
Then create a new pip or conda environment and activate it:
Using Conda:
conda env create -f environment.yml
conda activate qumphy
conda-develop .
Using pip:
python3 -m venv .venv
echo "*" > .venv/.gitignore # To exclude the pip env from git tracking
source .venv/bin/activate
pip install -r requirements.txt
pip install -e .
Now qumphy is ready to be used!
Documentation
As already mentioned above, you can find the documentation here: https://qumphy-software.readthedocs.io/en/latest/. You can also create the documentation locally by running
mamba activate qumphy
cd doc
make html
To view the local version of the documentation, open doc/build/html/index.html in any browser.
License
This work is licensed under European Union Public License v1.2 or later.
SPDX-License-Identifier: EUPL-1.2+
Funding
The 22HLT01 QUMPHY Software Package is part of the EPM project 22HLT01 QUMPHY. This project (22HLT01 QUMPHY) has received funding from the European Partnership on Metrology, co-financed from the European Union’s Horizon Europe Research and Innovation Programme and by the Participating States.