earthcarekit 0.1.1__tar.gz

earthcarekit-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Leonard König
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

earthcarekit-0.1.1/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: earthcarekit
+Version: 0.1.1
+Summary: A Python package to simplify working with EarthCARE satellite data.
+Author-email: Leonard König <koenig@tropos.de>
+License: MIT License
+        
+        Copyright (c) 2025 Leonard König
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.3.2
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: xarray>=2025.7.1
+Requires-Dist: matplotlib>=3.10.3
+Requires-Dist: plotly>=6.2.0
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: cartopy>=0.24.1
+Requires-Dist: cmcrameri>=1.9
+Requires-Dist: scipy>=1.16.1
+Requires-Dist: owslib>=0.34.1
+Requires-Dist: jupyterlab>=4.4.5
+Requires-Dist: vedo>=2025.5.4
+Requires-Dist: h5netcdf>=1.6.3
+Requires-Dist: netcdf4>=1.7.2
+Requires-Dist: tomli-w>=1.2.0
+Dynamic: license-file
+
+# earthcarekit
+
+[![GitHub Tag](https://img.shields.io/github/v/tag/TROPOS-RSD/earthcarekit?label=latest)](https://github.com/TROPOS-RSD/earthcarekit/tags)
+[![GitHub License](https://img.shields.io/github/license/TROPOS-RSD/earthcarekit)](https://github.com/TROPOS-RSD/earthcarekit/blob/main/LICENSE)
+
+A Python package to simplify working with EarthCARE satellite data.
+
+> ⚠️ **Project Status: In Development**
+> 
+> This project is still under active development.
+> It is **not yet feature-complete**, and parts of the **user documentation are missing or incomplete**.
+> Use at your own risk and expect breaking changes.
+> Feedback and contributions are welcome!
+
+> ⚠️ **Page status: Work in progess**
+
+## Key Features
+
+- **Download** - Access EarthCARE data from ESA's dissemination platfroms [OADS](https://ec-pdgs-dissemination2.eo.esa.int/oads/access/collection) or [MAAP](https://portal.maap.eo.esa.int/earthcare/) via the command line or your Python scripts.
+- **Search & Read** - Search your local EarthCARE products and open them as `xarray.Dataset` objects with unified dimension names.
+- **Process** - Filter data by time or geographic location, extract vertical profile statistics, rebin to common grids, interpolate along-track vertical cross sections from X-MET files and merge datasets from consecutive EarthCARE frames.
+- **Visualize** - Create quicklooks and plot vertical and across-track time series using a set of preset `matplotlib`/`cartopy`-based figure objects - while allowing customization.
+
+### Available Command Line Tools
+
+- [**ecdownload**](./docs/ecdownload.md) - Search, select, and download EarthCARE data from the command line.
+- [**ecquicklook**](./docs/ecquicklook.md) - Create fast quicklooks of your local EarthCARE products via the command line.
+
+## Getting Started
+
+### Step 1 - Installation
+
+Set up a Python 3.11+ environment with `pip` available, then install the latest version of `earthcarekit` from the Python Package Index (PyPI):
+
+> ⚠️ Not yet available: ~~`pip install earthcarekit`~~
+> 
+> Use instead latest prerelease version from Test PyPI:
+> ```
+> pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple earthcarekit
+> ```
+
+Alternatively, the package can be installed manually by cloning the repository and running:
+
+```
+pip install .
+```
+
+### Step 2 - Configuration
+
+An initial configuration step is required to specify default paths for storing data and created images, as well as to set up access to the supported data dissemination platforms for downloading.
+This involves creating and editing a configuration file - see [example_config.toml](./example_config.toml). Once applied via Python code, your settings will be saved to `~/.config/earthcarekit/default_config.toml`.
+
+Below, the configuration process is shown using the Python command line interpreter:
+
+1. **Open the Python interpreter and generate an example configuration file in your current directory:**
+
+    ```python
+    $ python
+    >>> import earthcarekit as eck
+    >>> eck.create_example_config()
+    ```
+
+2. **Edit the generated file.**
+   
+   Follow the instructions in the inline comments of the exsample file to customize your settings. You may rename and save your file to any location.
+3. **Go back to the Python Interpreter and apply your configuration file as default:**
+
+    ```python
+    >>> eck.set_config(path_to_file)
+    ```
+
+You can later view or manually edit the saved configuration at `~/.config/earthcarekit/default_config.toml`. To update your settings, you can also simply repeat the steps above.
+
+## Tutorials
+
+See usage examples:
+- Jupyter notebooks: [examples/notebooks/](./examples/notebooks/)
+- Documentation: [docs/tutorials.md](./docs/tutorials.md).
+
+## Author
+
+Developed and maintained by [Leonard König](https://orcid.org/0009-0004-3095-3969) ([TROPOS](https://www.tropos.de/en/)).
+
+## Contact
+
+For questions, suggestions, or bug reports, please create an issue or reach out via email: koenig@tropos.de
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+### Third-Party Licenses
+
+This project relies on several open-source packages. Their licenses include:
+- MIT License: `plotly`, `cmcrameri`, `vedo`, `netcdf4`, `tomli-w`
+- BSD License: `numpy`, `pandas`, `scipy`, `seaborn`, `owslib`, `jupyterlab`, `h5netcdf`
+- Apache 2.0 License: `xarray`
+- LGPL License: `cartopy`
+- PSF License: `matplotlib`
+
+Please refer to each project's repository for detailed license information.
+
+## Acknowledgments
+
+Colormap definitions for `calipso` and `chiljet2` were adapted from the exellent [ectools](https://bitbucket.org/smason/workspace/projects/EC) repository by Shannon Mason (ECMWF).

earthcarekit-0.1.1/README.md

@@ -0,0 +1,105 @@
+# earthcarekit
+
+[![GitHub Tag](https://img.shields.io/github/v/tag/TROPOS-RSD/earthcarekit?label=latest)](https://github.com/TROPOS-RSD/earthcarekit/tags)
+[![GitHub License](https://img.shields.io/github/license/TROPOS-RSD/earthcarekit)](https://github.com/TROPOS-RSD/earthcarekit/blob/main/LICENSE)
+
+A Python package to simplify working with EarthCARE satellite data.
+
+> ⚠️ **Project Status: In Development**
+> 
+> This project is still under active development.
+> It is **not yet feature-complete**, and parts of the **user documentation are missing or incomplete**.
+> Use at your own risk and expect breaking changes.
+> Feedback and contributions are welcome!
+
+> ⚠️ **Page status: Work in progess**
+
+## Key Features
+
+- **Download** - Access EarthCARE data from ESA's dissemination platfroms [OADS](https://ec-pdgs-dissemination2.eo.esa.int/oads/access/collection) or [MAAP](https://portal.maap.eo.esa.int/earthcare/) via the command line or your Python scripts.
+- **Search & Read** - Search your local EarthCARE products and open them as `xarray.Dataset` objects with unified dimension names.
+- **Process** - Filter data by time or geographic location, extract vertical profile statistics, rebin to common grids, interpolate along-track vertical cross sections from X-MET files and merge datasets from consecutive EarthCARE frames.
+- **Visualize** - Create quicklooks and plot vertical and across-track time series using a set of preset `matplotlib`/`cartopy`-based figure objects - while allowing customization.
+
+### Available Command Line Tools
+
+- [**ecdownload**](./docs/ecdownload.md) - Search, select, and download EarthCARE data from the command line.
+- [**ecquicklook**](./docs/ecquicklook.md) - Create fast quicklooks of your local EarthCARE products via the command line.
+
+## Getting Started
+
+### Step 1 - Installation
+
+Set up a Python 3.11+ environment with `pip` available, then install the latest version of `earthcarekit` from the Python Package Index (PyPI):
+
+> ⚠️ Not yet available: ~~`pip install earthcarekit`~~
+> 
+> Use instead latest prerelease version from Test PyPI:
+> ```
+> pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple earthcarekit
+> ```
+
+Alternatively, the package can be installed manually by cloning the repository and running:
+
+```
+pip install .
+```
+
+### Step 2 - Configuration
+
+An initial configuration step is required to specify default paths for storing data and created images, as well as to set up access to the supported data dissemination platforms for downloading.
+This involves creating and editing a configuration file - see [example_config.toml](./example_config.toml). Once applied via Python code, your settings will be saved to `~/.config/earthcarekit/default_config.toml`.
+
+Below, the configuration process is shown using the Python command line interpreter:
+
+1. **Open the Python interpreter and generate an example configuration file in your current directory:**
+
+    ```python
+    $ python
+    >>> import earthcarekit as eck
+    >>> eck.create_example_config()
+    ```
+
+2. **Edit the generated file.**
+   
+   Follow the instructions in the inline comments of the exsample file to customize your settings. You may rename and save your file to any location.
+3. **Go back to the Python Interpreter and apply your configuration file as default:**
+
+    ```python
+    >>> eck.set_config(path_to_file)
+    ```
+
+You can later view or manually edit the saved configuration at `~/.config/earthcarekit/default_config.toml`. To update your settings, you can also simply repeat the steps above.
+
+## Tutorials
+
+See usage examples:
+- Jupyter notebooks: [examples/notebooks/](./examples/notebooks/)
+- Documentation: [docs/tutorials.md](./docs/tutorials.md).
+
+## Author
+
+Developed and maintained by [Leonard König](https://orcid.org/0009-0004-3095-3969) ([TROPOS](https://www.tropos.de/en/)).
+
+## Contact
+
+For questions, suggestions, or bug reports, please create an issue or reach out via email: koenig@tropos.de
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+### Third-Party Licenses
+
+This project relies on several open-source packages. Their licenses include:
+- MIT License: `plotly`, `cmcrameri`, `vedo`, `netcdf4`, `tomli-w`
+- BSD License: `numpy`, `pandas`, `scipy`, `seaborn`, `owslib`, `jupyterlab`, `h5netcdf`
+- Apache 2.0 License: `xarray`
+- LGPL License: `cartopy`
+- PSF License: `matplotlib`
+
+Please refer to each project's repository for detailed license information.
+
+## Acknowledgments
+
+Colormap definitions for `calipso` and `chiljet2` were adapted from the exellent [ectools](https://bitbucket.org/smason/workspace/projects/EC) repository by Shannon Mason (ECMWF).

earthcarekit-0.1.1/earthcarekit/__init__.py

@@ -0,0 +1,40 @@
+"""
+earthcarekit
+============
+
+A Python package to simplify working with EarthCARE satellite data.
+
+Copyright (c) 2025 Leonard König
+
+Licensed under the MIT License (see LICENSE file or https://opensource.org/license/mit).
+"""
+
+__author__ = "Leonard König"
+__license__ = "MIT"
+__version__ = "0.1.1"
+__date__ = "2025-08-08"
+__maintainer__ = "Leonard König"
+__email__ = "koenig@tropos.de"
+__title__ = "earthcarekit"
+
+from .calval import *
+from .download import ecdownload
+from .plot import *
+from .plot import ecquicklook, ecswath
+from .utils import ProfileData, filter_radius, filter_time, set_config
+from .utils import statistics as stats
+from .utils.config import _warn_user_if_not_default_config_exists, create_example_config
+from .utils.geo import geodesic, haversine
+from .utils.ground_sites import GroundSite, get_ground_site
+from .utils.logging import _setup_logging
+from .utils.overpass import get_overpass_info
+from .utils.read import *
+
+__all__ = [
+    "ecquicklook",
+    "ecswath",
+    "ecdownload",
+]
+
+_setup_logging()
+_warn_user_if_not_default_config_exists()

earthcarekit-0.1.1/earthcarekit/calval/__init__.py

@@ -0,0 +1,3 @@
+from ._compare_bsc_ext_lr_depol import compare_bsc_ext_lr_depol
+
+__all__ = ["compare_bsc_ext_lr_depol"]