sfisop-datamodels


Namesfisop-datamodels JSON
Version 0.1.5 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-10-02 13:54:13
maintainerNone
docs_urlNone
authorYo581515
requires_python<4.0.0,>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Timeseries data model

The purpose of the data model is to support the exchange of time series data in particular exchange of fragments of data assosiated with time series. 

The data model is implemented based on the Pydantic framework: https://docs.pydantic.dev/latest/

The utility functions implemented in the `tsdata_utils.py` and `timeseriesdata.py` is to be used for serialisation and de-serialisation of time series data.

# Standards

The `parameter` and `unit` in the `Observation` class is to follow the Copernicus Marine in-situ TAC physical parameters list:

https://archimer.ifremer.fr/doc/00422/53381/

The `qualityCodes` is to follow the recommendations for in-situ data Near Real Time Quality Control:

https://archimer.ifremer.fr/doc/00251/36230/


The `time` object variable in the `Datapoint` class is to follow the ISO8601 standard and include timezone information.

# Installation

```
python -m pip install -r requirements.txt
```

Setup `PYTHONPATH` to include the top-level folder:

```
export PYTHONPATH=<path to top-level folder>/datamodels/
```

# Testing

Run `pytest` in the `datamodels/tests` folder.




            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sfisop-datamodels",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Yo581515",
    "author_email": "581515@stud.hvl.no",
    "download_url": "https://files.pythonhosted.org/packages/0a/5e/e8e332fa4cdc476977f7e36279b393f7e64df9427921261037ccd9ede612/sfisop_datamodels-0.1.5.tar.gz",
    "platform": null,
    "description": "# Timeseries data model\n\nThe purpose of the data model is to support the exchange of time series data in particular exchange of fragments of data assosiated with time series. \n\nThe data model is implemented based on the Pydantic framework: https://docs.pydantic.dev/latest/\n\nThe utility functions implemented in the `tsdata_utils.py` and `timeseriesdata.py` is to be used for serialisation and de-serialisation of time series data.\n\n# Standards\n\nThe `parameter` and `unit` in the `Observation` class is to follow the Copernicus Marine in-situ TAC physical parameters list:\n\nhttps://archimer.ifremer.fr/doc/00422/53381/\n\nThe `qualityCodes` is to follow the recommendations for in-situ data Near Real Time Quality Control:\n\nhttps://archimer.ifremer.fr/doc/00251/36230/\n\n\nThe `time` object variable in the `Datapoint` class is to follow the ISO8601 standard and include timezone information.\n\n# Installation\n\n```\npython -m pip install -r requirements.txt\n```\n\nSetup `PYTHONPATH` to include the top-level folder:\n\n```\nexport PYTHONPATH=<path to top-level folder>/datamodels/\n```\n\n# Testing\n\nRun `pytest` in the `datamodels/tests` folder.\n\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.1.5",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d43219427d71de4ff3bf24cbf1bca0af52a8b7a1349bc78a2b1592949c15bab8",
                "md5": "4afa057774b7656f9e0cf0431da7ac35",
                "sha256": "715ea2479200e2f983d042a58bf0e3aa89a4162492782bd66ff582acb62c900c"
            },
            "downloads": -1,
            "filename": "sfisop_datamodels-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4afa057774b7656f9e0cf0431da7ac35",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.9",
            "size": 3574,
            "upload_time": "2024-10-02T13:54:11",
            "upload_time_iso_8601": "2024-10-02T13:54:11.937615Z",
            "url": "https://files.pythonhosted.org/packages/d4/32/19427d71de4ff3bf24cbf1bca0af52a8b7a1349bc78a2b1592949c15bab8/sfisop_datamodels-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a5ee8e332fa4cdc476977f7e36279b393f7e64df9427921261037ccd9ede612",
                "md5": "bea7cfe287b2142e905c7f71fe9a76c8",
                "sha256": "4ebb13c7fb73ead4357b97f9ee84c3051166f83c1c7c9be29963ddaec8e1b085"
            },
            "downloads": -1,
            "filename": "sfisop_datamodels-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "bea7cfe287b2142e905c7f71fe9a76c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.9",
            "size": 2252,
            "upload_time": "2024-10-02T13:54:13",
            "upload_time_iso_8601": "2024-10-02T13:54:13.326800Z",
            "url": "https://files.pythonhosted.org/packages/0a/5e/e8e332fa4cdc476977f7e36279b393f7e64df9427921261037ccd9ede612/sfisop_datamodels-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-02 13:54:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "sfisop-datamodels"
}
        
Elapsed time: 0.31975s