blob: f0e7cce8f75ed16bc10b3d4449497961f58a80a0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# qolab
Collection of function and classes to run experimental hardware
and data analysis with python.
The package `qolab` was started in April 2021 by Eugeniy E. Mikhailov
within Quantum Optics Lab (QOLab), which explains it name.
## Developing
### Formatting
Adhere to [black](https://pypi.org/project/black/)
formatting style and run modified files via `black`.
I.e. do `black fname` or even more extreme
~~~~~
black .
~~~~~
to reformat the whole project.
### Linting
I find [flake8](https://github.com/PyCQA/flake8/tree/main)
to be quite good linter.
Make sure that you check for linting errors all the files
and review the messages.
Before committing and especially pushing, run
~~~~~
flake8 --max-line-length=88
~~~~~
here we set maximum line length to `black` default, which
is a bit longer `python` recommended 79.
### Test instructions
Make sure that you run the test suite and no errors are triggered.
~~~~~
export PYTHONPATH=.
python -m pytest
~~~~~
Note that we cannot just run `pytest` since I see no way to set the module search path.
## Build instructions
To build a python wheel package and put it in `./dist/` directory, run
~~~~~
flit build
~~~~~
|
