https://github.com/echemdb/unitpackage
A Python library to interact with a collection of frictionless datapackages
https://github.com/echemdb/unitpackage
Last synced: 21 days ago
JSON representation
A Python library to interact with a collection of frictionless datapackages
- Host: GitHub
- URL: https://github.com/echemdb/unitpackage
- Owner: echemdb
- License: gpl-3.0
- Created: 2023-05-08T21:37:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-03T05:52:07.000Z (22 days ago)
- Last Synced: 2025-05-03T06:26:13.942Z (22 days ago)
- Language: Python
- Homepage: https://echemdb.github.io/unitpackage/
- Size: 6.55 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
[](https://mybinder.org/v2/gh/echemdb/unitpackage/0.9.1?labpath=tree%2Fdoc%2Findex.md)
[](https://zenodo.org/badge/latestdoi/637997870)
This module provides a Python library to interact with a collection of
[frictionless datapackages](https://frictionlessdata.io/). Such datapackages consist of a CSV (data) file which is annotated with a JSON file.
This allows storing additional information such as units used in the columns of a CSV or store metadata describing the underlying data.
Example datapackages can be found [here](https://github.com/echemdb/unitpackage/tree/main/doc/files/) and a JSON could be structured as follows
```json
{
"resources": [
{
"name": "demo_package",
"type": "table",
"path": "demo_package.csv",
"scheme": "file",
"format": "csv",
"mediatype": "text/csv",
"encoding": "utf-8",
"schema": {
"fields": [
{
"name": "t",
"type": "number",
"unit": "s"
},
{
"name": "j",
"type": "number",
"unit": "A / m2"
}
]
},
"metadata": {
"echemdb": {
"description": "Sample data for the unitpackage module.",
"curation": {
"process": [
{
"role": "experimentalist",
"name": "John Doe",
"laboratory": "Institute of Good Scientific Practice",
"date": "2021-07-09"
}
]
}
}
}
}
]
}
```
The metadata of an entries' resource in a collection is accessible from the python API.
```python
>>> from unitpackage.collection import Collection
>>> db = Collection.from_local('./doc/files')
>>> entry = db['demo_package_cv']
>>> entry.description
'Sample data for the unitpackage module.'
```
From the API also a simple 2D plot can be drawn.
```python
>>> entry.plot()
```
Ultimately, the `unitpackage` allows for simple transformation of data within a resource into different units.
```python
>>> entry.get_unit('j')
'A / m2'
>>> entry.df
t E j
0 0.000000 -0.196962 0.043009
1 0.011368 -0.196393 0.051408
...
>>> entry.rescale({'E' : 'mV', 'j' : 'uA / m2'}).df
t E j
0 0.000000 -196.961730 43008.842162
1 0.011368 -196.393321 51408.199892
...
```
Collections for specific measurement types can be created, which provide additional accessibility to the meatadata or simplify the representation of such data in common plot types. An example of such a collection can be found on [echemdb.org](https://www.echemdb.org/cv), which shows Cyclic Voltammetry data annotated following [echemdb's metadata schema](https://github.com/echemdb/metadata-schema), which can be stored in a `CVCollection` and is retrieved from the [echemdb data repository](https://github.com/echemdb/electrochemistry-data).
Detailed installation instructions, description of the modules, advanced usage examples, including
local collection creation, are provided in our
[documentation](https://echemdb.github.io/unitpackage/).
# Installation instructions
This package is available on [PyPI](https://pypi.org/project/unitpackage/) and can be installed with pip:
```sh .noeval
pip install unitpackage
```
The package is also available on [conda-forge](https://github.com/conda-forge/unitpackage-feedstock) an can be installed with conda
```sh .noeval
conda install -c conda-forge unitpackage
```
Please consult our [documentation](https://echemdb.github.io/unitpackage/) for
more detailed [installation instructions](https://echemdb.github.io/unitpackage/installation.html).
# License
The contents of this repository are licensed under the [GNU General Public
License v3.0](./LICENSE) or, at your option, any later version.