pivmetalib

A Python library and high-level interface to work with the pivmeta ontology. It allows to describe PIV recordings, software, hardware and other related entities in a state-of-the-art and good scientific practice compliant way.

The library depends on ontolutils, which provides the object-oriented interface to the ontology and the JSON-LD serialization.

Usage

Installation

The package is available on PyPI and can be installed via pip:

pip install pivmetalib

Example of describing a PIV software:

It is very helpful to provide a description of the used PIV software together with the PIV recording. This can be done using the PIVSoftware class from the pivmeta module. The following example shows how to describe the OpenPIV software. Put the resulting JSON-LD to your website, data repository or other places to make your data FAIR. Other users or software can then easily understand and use your data.

from pivmetalib import pivmeta, prov

software = pivmeta.PIVSoftware(
    author=prov.Organization(
        name='OpenPIV',
        url='https://github.com/OpenPIV/openpiv-python',
    ),
    description='OpenPIV is an open source Particle Image Velocimetry analysis software written in Python and Cython',
    software_version="0.26.0a0",
    has_documentation='https://openpiv.readthedocs.io/en/latest/',
)

from pprint import pprint

pprint(software.model_dump(exclude_none=True)

This will result in the following JSON-LD representation:

{
    "@context": {
        "@import": "https://raw.githubusercontent.com/matthiasprobst/pivmeta/main/pivmeta_context.jsonld"
    },
    "@graph": [
        {
            "@id": "https://local-domain.org/9c0696ff-7b0f-43a5-9d36-afca62f0f374",
            "@type": "prov:Organization",
            "foaf:name": "OpenPIV",
            "schema:url": "https://github.com/OpenPIV/openpiv-python"
        },
        {
            "@id": "https://local-domain.org/82675f3e-8887-4a76-a62c-cc1119857735",
            "@type": "Piv Software",
            "schema:author": {
                "@id": "https://local-domain.org/9c0696ff-7b0f-43a5-9d36-afca62f0f374"
            },
            "schema:description": "OpenPIV is an open source Particle Image Velocimetry analysis software written in Python and Cython",
            "schema:softwareVersion": "0.26.0a0",
            "sd:hasDocumentation": "https://openpiv.readthedocs.io/en/latest/"
        }
    ]
}

Documentation and Usage

This library mainly implements the ontology in form of pydantic model classes. The pivmeta ontology uses other ontologies and builds on top of them. Thus, some central classes from ontologies like schema.org, prov, dcat and m4i are implemented, too.

Practical examples on how to use the library can be found in docs-folder ( e.g. Describe a PIV recording).

Contribution

Contributions are welcome. Please open an issue or a pull request.