ecaio 0.2.2__tar.gz

ecaio-0.2.2/LICENCE.txt

@@ -0,0 +1,367 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.

ecaio-0.2.2/MANIFEST.in

@@ -0,0 +1,3 @@
+include ReleaseNotes.md
+include src/ecaio/data/default_config.toml
+prune tests

ecaio-0.2.2/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: ecaio
+Version: 0.2.2
+Summary: Read-only access to EarthCARE data product files
+Author-email: Edward Baudrez <edward.baudrez@meteo.be>
+Project-URL: repository, https://gitlab.com/ebaudrez/ecaio
+Project-URL: issues, https://gitlab.com/ebaudrez/ecaio/-/issues
+Project-URL: releasenotes, https://gitlab.com/ebaudrez/ecaio/blob/main/ReleaseNotes.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENCE.txt
+Requires-Dist: astropy
+Requires-Dist: deprecated
+Requires-Dist: gdal
+Requires-Dist: geopandas
+Requires-Dist: netCDF4
+Requires-Dist: numpy
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Dynamic: license-file
+
+# ecaio - Read-only access to EarthCARE data product files
+
+## Synopsis
+
+```
+from ecaio import EcaioFilename, EcaioOpen, EcaioTime
+
+# ecaio can work with .zip-compressed files directly:
+my_msi_file = "ECA_EXAF_MSI_RGR_1C_20250219T114658Z_20250219T133232Z_04147D.ZIP"
+
+# Or you can locate files by glob(). The following will try and locate the
+# unique file that matches the following components, regardless of their
+# extension, processing start time, or anything else that was not specified
+# explicitly. If that doesn't work, an exception is raised.
+my_msi_file = EcaioFilename.glob_unique(
+    root_directory="/my/data/directory",
+    baseline="AF",
+    file_type="MSI_RGR_1C",
+    frame="4147D",
+)
+
+# EcaioOpen automatically dispatches to the right subclass, if it recognizes
+# the file type (currently, only M-NOM, M-RGR, and B-SNG); otherwise it opens
+# the file as a generic EarthCARE file.
+with EcaioOpen(my_msi_file) as msi:
+
+    # access any header property (here, from the Main Product Header)
+    description = msi.mph.description
+
+    # access fields from /ScienceData with the following convenient syntax
+    elevation = msi.surface_elevation
+
+    # ecaio has built-in recipes for some quantities, like MSI TIR thermal
+    # radiances (converted from brightness temperatures)
+    thermal_radiance = msi.thermal_radiance
+
+    # use EcaioTime to convert times in EarthCARE format to another format
+    # (here, to Python standard library ‘datetime’)
+    line_acquisition_times = EcaioTime.from_float(msi.time).to_datetime()
+```
+
+## Description
+
+`ecaio` is a Python library for convenient access to the data stored in
+EarthCARE data product files, together with derived quantities that can be
+computed from those data products. The data within `.zip`-compressed data
+product archives can be accessed transparently. Currently, access is read-only.
+`ecaio` strives to be fast, by caching and performing vector operations where
+possible, and convenient to use, by allowing you to retrieve data in few lines
+of code, with a syntax that is (hopefully) easy to remember.
+
+`ecaio` is not a library for plotting or analysis of EarthCARE data. There are
+other libraries that are better suited for that (e.g., `pandas`, `matplotlib`,
+and the tools listed under "See also" below), but `ecaio` strives to make it
+easy to prepare your data for subsequent analysis and plotting with other
+packages.
+
+## Features
+
+ - Work with `.zip`-compressed data product files directly
+ - Convenient syntax for access to datasets under `/ScienceData`:
+   `values = msi_rgr.pixel_values`
+ - Data are cached to avoid the time penalty when re-using the same data
+ - Recipes for a few derived quantities are already implemented, such as VNS
+   reflectances from radiances, TIR radiances from brightness temperatures, RGB
+   composites for MSI, narrowband-to-broadband conversion for MSI, computation
+   of frame margins, etc.
+ - Mask values from bad BBR detectors
+ - Correct and convenient conversion of time stamps to and from EarthCARE
+   format (i.e., float)
+ - Generic file opening with `EcaioOpen()`
+ - Convenient and fast spatial subsetting of data with `.subset_rectangle()`
+ - Conversion to GDAL raster datasets with geolocation metadata, to process the
+   data with [the GDAL library](https://gdal.org)
+
+## Project development status and interface stability
+
+`ecaio` is still under development, and its interface may change in the future.
+Some features have not been implemented yet, and not all EarthCARE file types
+are fully supported yet.
+
+## Homepage
+
+`ecaio` can be found at <https://gitlab.com/ebaudrez/ecaio>.
+
+## Installation instructions
+
+`ecaio` has not yet been uploaded to the Python Package Index, so for the time
+being, the recommended way to install it is to grab a `.tar.gz` archive from
+the Gitlab [release page](https://gitlab.com/ebaudrez/ecaio/-/releases), and to
+install it using
+
+```
+pip install ecaio-x.y.z.tar.gz
+```
+
+where _x.y.z_ is the version you've downloaded.
+
+## Bugs and known issues
+
+No bugs have been reported so far. Please report bugs or feature requests at
+<https://gitlab.com/ebaudrez/ecaio/-/issues>.
+
+## See also
+
+There are a number of other libraries that can ingest and process EarthCARE
+data, with a different focus than `ecaio`:
+
+- [ectools](https://bitbucket.org/smason/workspace/projects/EC) is a set of
+  open tools for searching, loading, plotting, intercomparing and analysing
+  EarthCARE data products, licensed under Apache 2.0
+- [earthcarekit](https://github.com/TROPOS-RSD/earthcarekit) is a comprehensive
+  toolkit for downloading, reading, analysing and visualizing data from
+  EarthCARE, licensed under Apache 2.0
+
+## Copyright and license
+
+Copyright (C) 2025, 2026 Edward Baudrez <edward.baudrez@meteo.be>
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.

ecaio-0.2.2/README.md

@@ -0,0 +1,122 @@
+# ecaio - Read-only access to EarthCARE data product files
+
+## Synopsis
+
+```
+from ecaio import EcaioFilename, EcaioOpen, EcaioTime
+
+# ecaio can work with .zip-compressed files directly:
+my_msi_file = "ECA_EXAF_MSI_RGR_1C_20250219T114658Z_20250219T133232Z_04147D.ZIP"
+
+# Or you can locate files by glob(). The following will try and locate the
+# unique file that matches the following components, regardless of their
+# extension, processing start time, or anything else that was not specified
+# explicitly. If that doesn't work, an exception is raised.
+my_msi_file = EcaioFilename.glob_unique(
+    root_directory="/my/data/directory",
+    baseline="AF",
+    file_type="MSI_RGR_1C",
+    frame="4147D",
+)
+
+# EcaioOpen automatically dispatches to the right subclass, if it recognizes
+# the file type (currently, only M-NOM, M-RGR, and B-SNG); otherwise it opens
+# the file as a generic EarthCARE file.
+with EcaioOpen(my_msi_file) as msi:
+
+    # access any header property (here, from the Main Product Header)
+    description = msi.mph.description
+
+    # access fields from /ScienceData with the following convenient syntax
+    elevation = msi.surface_elevation
+
+    # ecaio has built-in recipes for some quantities, like MSI TIR thermal
+    # radiances (converted from brightness temperatures)
+    thermal_radiance = msi.thermal_radiance
+
+    # use EcaioTime to convert times in EarthCARE format to another format
+    # (here, to Python standard library ‘datetime’)
+    line_acquisition_times = EcaioTime.from_float(msi.time).to_datetime()
+```
+
+## Description
+
+`ecaio` is a Python library for convenient access to the data stored in
+EarthCARE data product files, together with derived quantities that can be
+computed from those data products. The data within `.zip`-compressed data
+product archives can be accessed transparently. Currently, access is read-only.
+`ecaio` strives to be fast, by caching and performing vector operations where
+possible, and convenient to use, by allowing you to retrieve data in few lines
+of code, with a syntax that is (hopefully) easy to remember.
+
+`ecaio` is not a library for plotting or analysis of EarthCARE data. There are
+other libraries that are better suited for that (e.g., `pandas`, `matplotlib`,
+and the tools listed under "See also" below), but `ecaio` strives to make it
+easy to prepare your data for subsequent analysis and plotting with other
+packages.
+
+## Features
+
+ - Work with `.zip`-compressed data product files directly
+ - Convenient syntax for access to datasets under `/ScienceData`:
+   `values = msi_rgr.pixel_values`
+ - Data are cached to avoid the time penalty when re-using the same data
+ - Recipes for a few derived quantities are already implemented, such as VNS
+   reflectances from radiances, TIR radiances from brightness temperatures, RGB
+   composites for MSI, narrowband-to-broadband conversion for MSI, computation
+   of frame margins, etc.
+ - Mask values from bad BBR detectors
+ - Correct and convenient conversion of time stamps to and from EarthCARE
+   format (i.e., float)
+ - Generic file opening with `EcaioOpen()`
+ - Convenient and fast spatial subsetting of data with `.subset_rectangle()`
+ - Conversion to GDAL raster datasets with geolocation metadata, to process the
+   data with [the GDAL library](https://gdal.org)
+
+## Project development status and interface stability
+
+`ecaio` is still under development, and its interface may change in the future.
+Some features have not been implemented yet, and not all EarthCARE file types
+are fully supported yet.
+
+## Homepage
+
+`ecaio` can be found at <https://gitlab.com/ebaudrez/ecaio>.
+
+## Installation instructions
+
+`ecaio` has not yet been uploaded to the Python Package Index, so for the time
+being, the recommended way to install it is to grab a `.tar.gz` archive from
+the Gitlab [release page](https://gitlab.com/ebaudrez/ecaio/-/releases), and to
+install it using
+
+```
+pip install ecaio-x.y.z.tar.gz
+```
+
+where _x.y.z_ is the version you've downloaded.
+
+## Bugs and known issues
+
+No bugs have been reported so far. Please report bugs or feature requests at
+<https://gitlab.com/ebaudrez/ecaio/-/issues>.
+
+## See also
+
+There are a number of other libraries that can ingest and process EarthCARE
+data, with a different focus than `ecaio`:
+
+- [ectools](https://bitbucket.org/smason/workspace/projects/EC) is a set of
+  open tools for searching, loading, plotting, intercomparing and analysing
+  EarthCARE data products, licensed under Apache 2.0
+- [earthcarekit](https://github.com/TROPOS-RSD/earthcarekit) is a comprehensive
+  toolkit for downloading, reading, analysing and visualizing data from
+  EarthCARE, licensed under Apache 2.0
+
+## Copyright and license
+
+Copyright (C) 2025, 2026 Edward Baudrez <edward.baudrez@meteo.be>
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.