# 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/af/3b/182901a572caac5f4d9d935689c9c15d2c3ea60ead6411382cdca0b39057/paramdb-0.12.0.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.12.0",
"project_urls": {
"Homepage": "https://github.com/PainterQubits/paramdb",
"Repository": "https://github.com/PainterQubits/paramdb"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae3efbe796fc8cf20642ad33521ac6e4a460b63532e391c9092c4eb7e6fbc92f",
"md5": "b8ea1b0a9e6ab6fc6fec6563d8cb1cab",
"sha256": "368d003552d3e52cf5c5fdbf0069ab790466a812adf66cd63358bab32e951cff"
},
"downloads": -1,
"filename": "paramdb-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8ea1b0a9e6ab6fc6fec6563d8cb1cab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 17110,
"upload_time": "2024-05-08T18:17:45",
"upload_time_iso_8601": "2024-05-08T18:17:45.198398Z",
"url": "https://files.pythonhosted.org/packages/ae/3e/fbe796fc8cf20642ad33521ac6e4a460b63532e391c9092c4eb7e6fbc92f/paramdb-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af3b182901a572caac5f4d9d935689c9c15d2c3ea60ead6411382cdca0b39057",
"md5": "4d4ed9a61e69df1fc25d4f147743f9e1",
"sha256": "72d789ca764c9f0acb19be062952a87ec05fe9f6f06ffa001cb7628a01a24701"
},
"downloads": -1,
"filename": "paramdb-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "4d4ed9a61e69df1fc25d4f147743f9e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 14379,
"upload_time": "2024-05-08T18:17:47",
"upload_time_iso_8601": "2024-05-08T18:17:47.249474Z",
"url": "https://files.pythonhosted.org/packages/af/3b/182901a572caac5f4d9d935689c9c15d2c3ea60ead6411382cdca0b39057/paramdb-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 18:17:47",
"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
