MesoscoPy is a library of utils to run experiment in mesoscopic physics. It runs with qCoDeS. To learn more about the synatx, read First steps with mesoscoPy.
Refer to our documentation for installation.
Read it here. Documentation is updated and deployed on every successful build in master. We use sphinx for the documentation. To build the documentation locally, make sure that you have the extra dependencies required:
pip install -r docs_requirements.txt
Go to the directory docs
and type:
make html
It generates the documenation with rendered html in docs/_build/html
.
As mesoscoPy is still a project in its infancy, we have no strict rules for contribution. However, please make sure you test your code before pushing to the main
branch.
See License.