# ParamDB
<!-- start badges -->
[](https://pypi.org/project/paramdb/)
[](https://pypi.org/project/paramdb/)
[](https://github.com/PainterQubits/paramdb/blob/main/LICENSE)
[](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml)
[](https://codecov.io/github/PainterQubits/paramdb)
[](https://paramdb.readthedocs.io/en/stable/?badge=stable)
<!-- end badges -->
<!-- start intro -->
Python package for storing and retrieving experiment parameters.
<!-- end intro -->
## Installation
<!-- start installation -->
Install the latest version of ParamDB using pip:
```
pip install -U paramdb
```
ParamDB has several extras:
- `pandas` for [`pandas.DataFrame`] support via [`paramdb.ParamDataFrame`]
- `astropy` for [`astropy.units.Quantity`] support
- `pydantic` for type-validation support via [Pydantic]
To install all extras, use the `all` extra:
```
pip install -U "paramdb[all]"
```
[`pandas.DataFrame`]: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html
[`paramdb.ParamDataFrame`]: https://paramdb.readthedocs.io/en/stable/api-reference.html#paramdb.ParamDataFrame
[`astropy.units.quantity`]: https://docs.astropy.org/en/stable/api/astropy.units.Quantity.html#astropy.units.Quantity
[Pydantic]: https://docs.pydantic.dev/latest/
<!-- end installation -->
## Usage
ParamDB has two main components:
- [**Parameter Data**]: Base classes that are used to defined the structure and
functionality of parameter data.
- [**Database**]: A database object that commits and loads parameter data to a persistent
file.
See the [api reference] for more information.
[**parameter data**]: https://paramdb.readthedocs.io/en/stable/parameter-data.html
[**database**]: https://paramdb.readthedocs.io/en/stable/database.html
[api reference]: https://paramdb.readthedocs.io/en/stable/api-reference.html
Raw data
{
"_id": null,
"home_page": "https://github.com/PainterQubits/paramdb",
"name": "paramdb",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Alex Hadley",
"author_email": "contact@alexhadley.net",
"download_url": "https://files.pythonhosted.org/packages/e7/05/aaab573907f86813d6a01cfe76ec55e20974a13079d41d655f0cb292b479/paramdb-0.15.2.tar.gz",
"platform": null,
"description": "# ParamDB\n\n<!-- start badges -->\n\n[](https://pypi.org/project/paramdb/)\n[](https://pypi.org/project/paramdb/)\n[](https://github.com/PainterQubits/paramdb/blob/main/LICENSE)\n[](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml)\n[](https://codecov.io/github/PainterQubits/paramdb)\n[](https://paramdb.readthedocs.io/en/stable/?badge=stable)\n\n<!-- end badges -->\n\n<!-- start intro -->\n\nPython package for storing and retrieving experiment parameters.\n\n<!-- end intro -->\n\n## Installation\n\n<!-- start installation -->\n\nInstall the latest version of ParamDB using pip:\n\n```\npip install -U paramdb\n```\n\nParamDB has several extras:\n\n- `pandas` for [`pandas.DataFrame`] support via [`paramdb.ParamDataFrame`]\n- `astropy` for [`astropy.units.Quantity`] support\n- `pydantic` for type-validation support via [Pydantic]\n\nTo install all extras, use the `all` extra:\n\n```\npip install -U \"paramdb[all]\"\n```\n\n[`pandas.DataFrame`]: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html\n[`paramdb.ParamDataFrame`]: https://paramdb.readthedocs.io/en/stable/api-reference.html#paramdb.ParamDataFrame\n[`astropy.units.quantity`]: https://docs.astropy.org/en/stable/api/astropy.units.Quantity.html#astropy.units.Quantity\n[Pydantic]: https://docs.pydantic.dev/latest/\n\n<!-- end installation -->\n\n## Usage\n\nParamDB has two main components:\n\n- [**Parameter Data**]: Base classes that are used to defined the structure and\n functionality of parameter data.\n\n- [**Database**]: A database object that commits and loads parameter data to a persistent\n file.\n\nSee the [api reference] for more information.\n\n[**parameter data**]: https://paramdb.readthedocs.io/en/stable/parameter-data.html\n[**database**]: https://paramdb.readthedocs.io/en/stable/database.html\n[api reference]: https://paramdb.readthedocs.io/en/stable/api-reference.html\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Python package for storing and retrieving experiment parameters.",
"version": "0.15.2",
"project_urls": {
"Homepage": "https://github.com/PainterQubits/paramdb",
"Repository": "https://github.com/PainterQubits/paramdb"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e156f7539d021b1a879216e782b8f408387062af65238d340bdaa549aef00067",
"md5": "ef0e3e190d289521722365a4a470e230",
"sha256": "c458c0206bd78cce888a1235010ec70ee64353ede67072d60eb6ea015079dbae"
},
"downloads": -1,
"filename": "paramdb-0.15.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef0e3e190d289521722365a4a470e230",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 17861,
"upload_time": "2024-06-28T20:32:21",
"upload_time_iso_8601": "2024-06-28T20:32:21.933270Z",
"url": "https://files.pythonhosted.org/packages/e1/56/f7539d021b1a879216e782b8f408387062af65238d340bdaa549aef00067/paramdb-0.15.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e705aaab573907f86813d6a01cfe76ec55e20974a13079d41d655f0cb292b479",
"md5": "90fbe7e2bc43caa64c91f96d8a482e9d",
"sha256": "896975e4fb29234dd4cc7588b043d0b4b52ee4c988813323431a15559de43062"
},
"downloads": -1,
"filename": "paramdb-0.15.2.tar.gz",
"has_sig": false,
"md5_digest": "90fbe7e2bc43caa64c91f96d8a482e9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 15365,
"upload_time": "2024-06-28T20:32:23",
"upload_time_iso_8601": "2024-06-28T20:32:23.210237Z",
"url": "https://files.pythonhosted.org/packages/e7/05/aaab573907f86813d6a01cfe76ec55e20974a13079d41d655f0cb292b479/paramdb-0.15.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 20:32:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PainterQubits",
"github_project": "paramdb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "paramdb"
}
JSON
