Metadata-Version: 2.4
Name: l2o-corealg
Version: 0.2.0
Summary: ESA ROSE-L Level-2 Ocean Processor Core Algorithm Library
Author: RL2Ocean Project Contributors
License-Expression: Apache-2.0
Project-URL: Homepage, https://rl2ocean.org/
Project-URL: Documentation, https://rl2ocean.pages.gitlab.dlr.de/l2o-corealg
Project-URL: Repository, https://gitlab.dlr.de/rl2ocean/l2o-corealg
Project-URL: Issues, https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/issues
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Oceanography
Classifier: Typing :: Typed
Requires-Python: >=3.13
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy>=2
Requires-Dist: scipy>=1.16
Requires-Dist: xarray>=2026
Provides-Extra: notebook
Requires-Dist: jupyter<2,>=1; extra == "notebook"
Provides-Extra: all
Requires-Dist: l2o-corealg[notebook]; extra == "all"
Dynamic: license-file

L2O-COREALG
===========

|pipeline|
|coverage|
|docstr-coverage|

This repository contains the ROSE-L Level-2 Ocean Processor Core Algorithm Library, L2O-COREALG.

* **Website:** https://rl2ocean.org/
* **Source code:** https://gitlab.dlr.de/rl2ocean/l2o-corealg
* **Documentation:** https://rl2ocean.pages.gitlab.dlr.de/l2o-corealg
* **Installation:** https://rl2ocean.pages.gitlab.dlr.de/l2o-corealg/main/sim.html
* **API reference:** https://rl2ocean.pages.gitlab.dlr.de/l2o-corealg/main/api/l2o.corealg.html
* **Contributing:** https://rl2ocean.pages.gitlab.dlr.de/l2o-corealg/main/contributing.html
* **Bug reports:** https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/issues


Project Structure
-----------------

This project is organized as follows:

* ``src``: Source code of the Python package
* ``tests``: Unit and integration tests
* ``docs``: Source code of the documentation


Tools
-----

The following tools are used by this project:

* ``.gitlab-ci.yml``: GitLab CI/CD pipeline configuration
* ``pre-commit-config.yaml``: Pre-commit hooks executed on commits
* ``pyproject.toml``: Build system requirements for Python packaging
* ``environment.yml``: Package list for setting up a development environment using Conda
* ``requirements.txt``: Package list for setting up a development environment using PIP
* ``.vscode``: Settings and recommendations for the VS Code IDE
* ``docs/conf.py``: Sphinx documentation generator configuration


License
-------

Copyright 2026 RL2Ocean Project Contributors.

This package is licensed under the Apache License, Version 2.0. See `LICENSE <https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/blob/main/LICENSE>`__ for the full license text.


.. |pipeline| image:: https://gitlab.dlr.de/rl2ocean/l2o-corealg/badges/main/pipeline.svg
   :target: https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/commits/main

.. |coverage| image:: https://gitlab.dlr.de/rl2ocean/l2o-corealg/badges/main/coverage.svg
   :target: https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/commits/main

.. |docstr-coverage| image:: https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/jobs/artifacts/main/raw/docstrcov.svg?job=docstring-coverage
   :target: https://gitlab.dlr.de/rl2ocean/l2o-corealg/-/commits/main
