MeasFunc is a repository for functions and classes used for doing measurements at QDev. You are alowed to put (almost) everything in this repo. If a spcific function/class/projekt inside this repo matures we will migrate it to a seperatte repository.
On a good day, installation is as easy as
$ git clone https://github.com/qdev-dk/MeasFunc.git
$ cd MeasFunc
$ pip install -e .
If you have installed MeasFunc, and saved a file (ex. myfile.py) in the directory MeasFunc\measfunc\ containing a function (ex. myfunc) you can esaly import you function:
from measfunc.myfile import myfuncIf you have gotten 'measfunc' from source, you may run the tests locally.
Install measfunc along with its test dependencies into your virtual environment by executing the following in the root folder
$ pip install .
$ pip install -r test_requirements.txtThen run pytest in the tests folder.
If you have gotten measfunc from source, you may build the docs locally.
Install measfunc along with its documentation dependencies into your virtual environment by executing the following in the root folder
$ pip install .
$ pip install -r docs_requirements.txtYou also need to install pandoc. If you are using conda, that can be achieved by
$ conda install pandocelse, see here for pandoc's installation instructions.
Then run make html in the docs folder. The next time you build the documentation, remember to run make clean before you run make html.