xseof
=====
Overview
--------
I/O library for the ESA EOF files.
This package provides a set of "dataclasses", comapible with the
xsdata_ Python library, to access and make I/O operation on the XML files
in the ESA Earth Observation Ground Segment File Format (EOF) [1]_.
In particular, this package supports all the XML based orbit and attitude
products described in [1]_.
Project links
-------------
:Home Page:
https://github.com/avalentino/xseof
:Download:
https://pypi.org/project/xseof
Installation
------------
Standard installation via pip_::
$ pip install xseof
Installation via conda_::
$ conda install -c avalentino xseof
Testing
-------
Move to the the source directory root and run the following command::
$ python3 -m pytest
Basic usage
-----------
Load a generic orbit file::
>>> import xseof
>>> orbit = xseof.load(
"MA1_TEST_AUX_ORBRES_20210610T045753_20210610T065853_0001.EOF")
Access and print loaded data::
>>> import pprint
>>> orbit.earth_observation_header.fixed_header.notes = ""
>>> pprint.pprint(orbit.earth_observation_header.fixed_header)
FixedHeaderType(
file_name='MA1_TEST_AUX_ORBRES_20210610T045753_20210610T065853_0001',
file_description='FOS Orbit File',
notes='',
mission='MetOpSGA1',
file_class='TEST',
file_type='AUX_ORBRES',
validity_period=ValidityPeriodType(
validity_start='UTC=2021-06-10T04:57:53',
validity_stop='UTC=2021-06-10T05:02:23'),
file_version='0001',
eoffs_version='3.0',
source=SourceType(system='System Identification as per Ground '
'Segment File Format Standard '
'(PE-TN-ESA-GS-0001)',
creator='Creator Identification as per '
'Ground Segment File Format Standard '
'(PE-TN-ESA-GS-0001)',
creator_version='Creator Version '
'Identification as per '
'Ground Segment File Format '
'Standard '
'(PE-TN-ESA-GS-0001)',
creation_date='UTC=2022-06-23T10:06:43'))
>>> print(orbit.data_block.list_of_osvs.count)
10
>>> pprint.pprint(orbit.data_block.list_of_osvs.osv[0])
OsvType(tai='TAI=2021-06-10T04:57:17.817060',
utc='UTC=2021-06-10T04:57:52.817060',
ut1='UT1=2021-06-10T04:57:53.117059',
absolute_orbit=999,
x=PositionComponentType(value=Decimal('-1606749.988'), unit='m'),
y=PositionComponentType(value=Decimal('-5677008.966'), unit='m'),
z=PositionComponentType(value=Decimal('-4135675.595'), unit='m'),
vx=VelocityComponentType(value=Decimal('-2876.652288'), unit='m/s'),
vy=VelocityComponentType(value=Decimal('-3541.028256'), unit='m/s'),
vz=VelocityComponentType(value=Decimal('5985.303441'), unit='m/s'),
quality='0000000000000')
Load an EOF file of a specific type::
>>> from xseof import int_attref
>>> quaternions = int_attref.load(
"MA1_TEST_INT_ATTREF_20210610T045753_20210610T065853_0001.EOF")
Load data form string::
>>> from xseof import aux_orbres
>>> filename = "MA1_TEST_AUX_ORBRES_20210610T045753_20210610T065853_0001.EOF"
>>> with open(filename) as fd:
... data = fd.read()
>>> orbit = aux_orbres.from_string(data)
Licanse
-------
Copyright 2022 Antonio Valentino
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific langua
.. _xsdata: https://github.com/tefra/xsdata
.. _pip: https://pip.pypa.io
.. _conda: https://docs.conda.io
.. [1] https://eop-cfi.esa.int/Repo/PUBLIC/DOCUMENTATION/SYSTEM_SUPPORT_DOCS/PE-TN-ESA-GS-0001%20EO%20GS%20File%20Format%20Standard%203.0%20signed.pdf
Version history
===============
xseof v1.1.1 (27/12/2022)
-------------------------
* Improve robustness in EOF files detection.
* Improve support for element-tree imputs.
xseof v1.1.0 (23/12/2022)
-------------------------
* Fix loading of Sentine-1 orbit form string.
* New `strict` option (default: `False`) to enforce strict XML namespaces
checking in `xseof.load` and `xseof.from_string`.
* Improve docstrings to clarify that `lxml` is needed to use an `ElementTree`
as source for the `xseof.load` and `xseof.*.load` functions.
A dedicated unit test has been added also.
* Test coverage improved.
xseof v1.0.0 (20/11/2022)
-------------------------
* Initial release.
Raw data
{
"_id": null,
"home_page": "",
"name": "xseof",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "orbit,attitude,dataclasses",
"author": "Antonio Valentino",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/17/3f/32b8b37914e8848329d94194a00ae205e9e0a90ce71b2f65282b1327c154/xseof-1.1.1.tar.gz",
"platform": "any",
"description": "xseof\n=====\n\nOverview\n--------\n\nI/O library for the ESA EOF files.\n\nThis package provides a set of \"dataclasses\", comapible with the\nxsdata_ Python library, to access and make I/O operation on the XML files\nin the ESA Earth Observation Ground Segment File Format (EOF) [1]_.\n\nIn particular, this package supports all the XML based orbit and attitude\nproducts described in [1]_.\n\n\nProject links\n-------------\n\n:Home Page:\n https://github.com/avalentino/xseof\n:Download:\n https://pypi.org/project/xseof\n\n\nInstallation\n------------\n\nStandard installation via pip_::\n\n $ pip install xseof\n\nInstallation via conda_::\n\n $ conda install -c avalentino xseof\n\n\nTesting\n-------\n\nMove to the the source directory root and run the following command::\n\n $ python3 -m pytest\n\n\nBasic usage\n-----------\n\nLoad a generic orbit file::\n\n >>> import xseof\n >>> orbit = xseof.load(\n \"MA1_TEST_AUX_ORBRES_20210610T045753_20210610T065853_0001.EOF\")\n\n\nAccess and print loaded data::\n\n >>> import pprint\n >>> orbit.earth_observation_header.fixed_header.notes = \"\"\n >>> pprint.pprint(orbit.earth_observation_header.fixed_header)\n FixedHeaderType(\n file_name='MA1_TEST_AUX_ORBRES_20210610T045753_20210610T065853_0001',\n file_description='FOS Orbit File',\n notes='',\n mission='MetOpSGA1',\n file_class='TEST',\n file_type='AUX_ORBRES',\n validity_period=ValidityPeriodType(\n validity_start='UTC=2021-06-10T04:57:53',\n validity_stop='UTC=2021-06-10T05:02:23'),\n file_version='0001',\n eoffs_version='3.0',\n source=SourceType(system='System Identification as per Ground '\n 'Segment File Format Standard '\n '(PE-TN-ESA-GS-0001)',\n creator='Creator Identification as per '\n 'Ground Segment File Format Standard '\n '(PE-TN-ESA-GS-0001)',\n creator_version='Creator Version '\n 'Identification as per '\n 'Ground Segment File Format '\n 'Standard '\n '(PE-TN-ESA-GS-0001)',\n creation_date='UTC=2022-06-23T10:06:43'))\n\n >>> print(orbit.data_block.list_of_osvs.count)\n 10\n >>> pprint.pprint(orbit.data_block.list_of_osvs.osv[0])\n OsvType(tai='TAI=2021-06-10T04:57:17.817060',\n utc='UTC=2021-06-10T04:57:52.817060',\n ut1='UT1=2021-06-10T04:57:53.117059',\n absolute_orbit=999,\n x=PositionComponentType(value=Decimal('-1606749.988'), unit='m'),\n y=PositionComponentType(value=Decimal('-5677008.966'), unit='m'),\n z=PositionComponentType(value=Decimal('-4135675.595'), unit='m'),\n vx=VelocityComponentType(value=Decimal('-2876.652288'), unit='m/s'),\n vy=VelocityComponentType(value=Decimal('-3541.028256'), unit='m/s'),\n vz=VelocityComponentType(value=Decimal('5985.303441'), unit='m/s'),\n quality='0000000000000')\n\n\nLoad an EOF file of a specific type::\n\n >>> from xseof import int_attref\n >>> quaternions = int_attref.load(\n \"MA1_TEST_INT_ATTREF_20210610T045753_20210610T065853_0001.EOF\")\n\n\nLoad data form string::\n\n >>> from xseof import aux_orbres\n >>> filename = \"MA1_TEST_AUX_ORBRES_20210610T045753_20210610T065853_0001.EOF\"\n >>> with open(filename) as fd:\n ... data = fd.read()\n >>> orbit = aux_orbres.from_string(data)\n\n\nLicanse\n-------\n\nCopyright 2022 Antonio Valentino\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific langua\n\n\n.. _xsdata: https://github.com/tefra/xsdata\n.. _pip: https://pip.pypa.io\n.. _conda: https://docs.conda.io\n\n.. [1] https://eop-cfi.esa.int/Repo/PUBLIC/DOCUMENTATION/SYSTEM_SUPPORT_DOCS/PE-TN-ESA-GS-0001%20EO%20GS%20File%20Format%20Standard%203.0%20signed.pdf\n\n\nVersion history\n===============\n\nxseof v1.1.1 (27/12/2022)\n-------------------------\n\n* Improve robustness in EOF files detection.\n* Improve support for element-tree imputs.\n\n\nxseof v1.1.0 (23/12/2022)\n-------------------------\n\n* Fix loading of Sentine-1 orbit form string.\n* New `strict` option (default: `False`) to enforce strict XML namespaces\n checking in `xseof.load` and `xseof.from_string`.\n* Improve docstrings to clarify that `lxml` is needed to use an `ElementTree`\n as source for the `xseof.load` and `xseof.*.load` functions.\n A dedicated unit test has been added also.\n* Test coverage improved.\n\n\nxseof v1.0.0 (20/11/2022)\n-------------------------\n\n* Initial release.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "I/O library for the ESA EOF files.",
"version": "1.1.1",
"split_keywords": [
"orbit",
"attitude",
"dataclasses"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ac06f7ecaf2fe6bd6a9ed83480715350",
"sha256": "797035e8a9bf17931b090bc3dbee3b3e4c4a13a23a750531f6638c509e82dd0a"
},
"downloads": -1,
"filename": "xseof-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac06f7ecaf2fe6bd6a9ed83480715350",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 169320,
"upload_time": "2022-12-27T16:39:18",
"upload_time_iso_8601": "2022-12-27T16:39:18.547877Z",
"url": "https://files.pythonhosted.org/packages/dc/27/6518d55653b45b6283737ae572df24fb119dc497cae8a2523e25add38206/xseof-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "38189393a48b6076563438ea512ca070",
"sha256": "de2eeb9c5e9512cf0c76c557392d91bbf8e8999aa27e987bc08af9ab35040e1a"
},
"downloads": -1,
"filename": "xseof-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "38189393a48b6076563438ea512ca070",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 48723,
"upload_time": "2022-12-27T16:39:20",
"upload_time_iso_8601": "2022-12-27T16:39:20.534394Z",
"url": "https://files.pythonhosted.org/packages/17/3f/32b8b37914e8848329d94194a00ae205e9e0a90ce71b2f65282b1327c154/xseof-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-27 16:39:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "xseof"
}
JSON