# QuMADA
Interfaces and measurement scripts for usage with QCoDeS.
## Documentation
Find the current documentation on [readthedocs](https://qumada.readthedocs.io/en/latest/).
## Installation
### Setup virtual environment
Installation of QuMADA should be done in a virtual environment.
There are several methods of creating a virtual environment, python's native being *venv*:
On *windows*, run
```
python -m venv .venv
.venv\Scripts\activate.bat
```
On *linux*, run
```
python -m venv .venv
source .venv/bin/activate
```
### Install QuMADA
Install QuMADA directly from PyPI:
```
python -m pip install qumada
```
Alternatively, install the latest development version of QuMADA from github:
```
git clone https://github.com/qutech/qumada.git qumada
cd qumada
python -m pip install -e .
```
You can also install optional dependencies, like *Spyder* or QCoDeS' *plottr-inspectr*:
```
python -m pip install -e .[spyder,gui]
```
### Setup for development
For development, first clone the latest development version of QuMADA from github:
```
git clone https://github.com/qutech/qumada.git qumada
cd qumada
```
The requirements are stored in *dev_requirements.txt*.
```
python -m pip install -r dev_requirements.txt
```
Set up pre-commit hooks
```
python -m pre-commit install
```
### Build documentation
To build the documentation, run:
```
tox -e docs
```
or
```
cd docs
make html
```
The built documentation can be found at `_build/html/index.html`.
Raw data
{
"_id": null,
"home_page": "",
"name": "QuMADA",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "quantum,physics,abstraction,metadata,data management",
"author": "JARA Institute for Quantum Information",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e8/88/cfdfe6ea8cf6ed09df7948c96f1b1cc01a66efa0262d983e2c9f6e6fbf04/QuMADA-0.4.2.tar.gz",
"platform": null,
"description": "# QuMADA\r\nInterfaces and measurement scripts for usage with QCoDeS.\r\n\r\n## Documentation\r\nFind the current documentation on [readthedocs](https://qumada.readthedocs.io/en/latest/).\r\n\r\n## Installation\r\n\r\n### Setup virtual environment\r\n\r\nInstallation of QuMADA should be done in a virtual environment.\r\nThere are several methods of creating a virtual environment, python's native being *venv*:\r\n\r\nOn *windows*, run\r\n\r\n```\r\npython -m venv .venv\r\n.venv\\Scripts\\activate.bat\r\n```\r\n\r\nOn *linux*, run\r\n\r\n```\r\npython -m venv .venv\r\nsource .venv/bin/activate\r\n```\r\n\r\n### Install QuMADA\r\n\r\nInstall QuMADA directly from PyPI:\r\n\r\n```\r\npython -m pip install qumada\r\n```\r\n\r\nAlternatively, install the latest development version of QuMADA from github:\r\n\r\n```\r\ngit clone https://github.com/qutech/qumada.git qumada\r\ncd qumada\r\npython -m pip install -e .\r\n```\r\n\r\nYou can also install optional dependencies, like *Spyder* or QCoDeS' *plottr-inspectr*:\r\n\r\n```\r\npython -m pip install -e .[spyder,gui]\r\n```\r\n\r\n### Setup for development\r\n\r\nFor development, first clone the latest development version of QuMADA from github:\r\n\r\n```\r\ngit clone https://github.com/qutech/qumada.git qumada\r\ncd qumada\r\n```\r\n\r\nThe requirements are stored in *dev_requirements.txt*.\r\n\r\n```\r\npython -m pip install -r dev_requirements.txt\r\n```\r\n\r\nSet up pre-commit hooks\r\n\r\n```\r\npython -m pre-commit install\r\n```\r\n\r\n### Build documentation\r\n\r\nTo build the documentation, run:\r\n\r\n```\r\ntox -e docs\r\n```\r\n\r\nor\r\n\r\n```\r\ncd docs\r\nmake html\r\n```\r\n\r\nThe built documentation can be found at `_build/html/index.html`.\r\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Measurement Abstraction and Database Access layer for QCoDeS",
"version": "0.4.2",
"project_urls": {
"Documentation": "https://qumada.readthedocs.io/en/latest/",
"Repository": "https://github.com/qutech/qumada"
},
"split_keywords": [
"quantum",
"physics",
"abstraction",
"metadata",
"data management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc7842821fcb9b4b88000eeaaa806257891b8975c968c8b9e69d58ef72ed094f",
"md5": "667789a085d0836d7792f94961c7ba11",
"sha256": "3d209cb548dddfe9d8f5cc28e3639175fe2eaf64c8f2735750f8622bbfd0aafc"
},
"downloads": -1,
"filename": "QuMADA-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "667789a085d0836d7792f94961c7ba11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 130790,
"upload_time": "2023-08-18T06:37:34",
"upload_time_iso_8601": "2023-08-18T06:37:34.577022Z",
"url": "https://files.pythonhosted.org/packages/dc/78/42821fcb9b4b88000eeaaa806257891b8975c968c8b9e69d58ef72ed094f/QuMADA-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e888cfdfe6ea8cf6ed09df7948c96f1b1cc01a66efa0262d983e2c9f6e6fbf04",
"md5": "322fb93187bb08252153e5ba1b366de7",
"sha256": "a6b36a1443459516495014c5bf547cce431c8cd437aa4eb05024453384d548e2"
},
"downloads": -1,
"filename": "QuMADA-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "322fb93187bb08252153e5ba1b366de7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 147303,
"upload_time": "2023-08-18T06:37:36",
"upload_time_iso_8601": "2023-08-18T06:37:36.466226Z",
"url": "https://files.pythonhosted.org/packages/e8/88/cfdfe6ea8cf6ed09df7948c96f1b1cc01a66efa0262d983e2c9f6e6fbf04/QuMADA-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-18 06:37:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qutech",
"github_project": "qumada",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "qumada"
}
JSON
