Metadata-Version: 2.1
Name: mqml
Version: 0.1.1
Summary: Package required to easily run measurements and analysis for the Microsoft Quantum Materials Lyngby lab. The source codes do not include Microsoft IP and are open source, so these packages could be generally useable.
Home-page: UNKNOWN
Author: Farzad Bonabi
Author-email: farzadb58@gmail.com
License: MIT
Description: # MQML
        
        Packages for measurement and analysis for the Microsoft Quantum Materials Lyngby lab.
        
        # Description
        
        This repository holds all packages, docs and tests for measurement and analysis running at Microsoft Quantum Materials Lyngby lab.
        This repository is built on top of QCoDeS and depends on it.
        
        # Installation
        
        Clone the repository from MQML_scripts github. Navigate to the cloned directory on your PC and install it to the environment you already have created for QCoDeS:
        ```bash
        $ pip install .
        ```
        
        # Usage
        
        It is mainly designed for usage at Microsoft Quantum Materials Lyngby lab. However, anybody who has the access to this repository can use it for his/ her experiments.
        
        ## Running the tests
        
        If you have gotten 'mqml' from source, you may run the tests locally.
        
        Install `mqml` along with its test dependencies into your virtual environment by executing the following in the root folder
        
        ```bash
        $ pip install -r test_requirements.txt
        ```
        
        Then run `pytest` in the `tests` folder.
        
        ## Building the documentation
        
        If you have gotten `mqml` from source, you may build the docs locally.
        
        Install `mqml` along with its documentation dependencies into your virtual environment by executing the following in the root folder
        
        ```bash
        $ pip install -r docs_requirements.txt
        ```
        
        Then run `make html` in the `docs` folder. This generate a webpage, index.html, in docs/_build/html with the rendered html. The next time you build the documentation, remember to run `make clean` before you run `make html`.
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/markdown
