Skip to main content

I/O library for the ESA EOF files.

Project description

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].

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

Version history

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xseof-1.1.0.tar.gz (47.2 kB view details)

Uploaded Source

Built Distribution

xseof-1.1.0-py3-none-any.whl (167.9 kB view details)

Uploaded Python 3

File details

Details for the file xseof-1.1.0.tar.gz.

File metadata

  • Download URL: xseof-1.1.0.tar.gz
  • Upload date:
  • Size: 47.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for xseof-1.1.0.tar.gz
Algorithm Hash digest
SHA256 55e069842ba7c9c3ebea02e51c04aaeb1b4c932c4cd9af393dab9319522599ac
MD5 7d8a429aa19446531aeef9edc0bc1a2d
BLAKE2b-256 f3a8723c0f91bb55052009b228796a927a069e9f1b5d316ac3c81da4f0e91473

See more details on using hashes here.

Provenance

File details

Details for the file xseof-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: xseof-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 167.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for xseof-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55fe9da11daa538638692a8e0421746ea099d81484f2d1c344609a8de39bd42b
MD5 deb9b8817c771fa75bcf242bc3c34148
BLAKE2b-256 578ee3fbc43c976395b9f264c63a01a4fdab9f832f624c3d6cc93299149ea440

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page