Metadata-Version: 2.4
Name: CADET
Version: 1.0.0
Summary: CADET metapackage.
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: <3.14,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cadet-process==0.11.1
Requires-Dist: cadet-core==5.1.1
Provides-Extra: rdm
Requires-Dist: cadet-rdm>=1.0.1; extra == "rdm"
Provides-Extra: all
Requires-Dist: cadet-rdm>=1.0.1; extra == "all"
Dynamic: license-file

[![PyPI version](https://img.shields.io/pypi/v/cadet.svg)](https://pypi.org/project/cadet/)
[![Python](https://img.shields.io/pypi/pyversions/cadet.svg)](https://pypi.org/project/cadet/)
[![License](https://img.shields.io/github/license/cadet/cadet)](LICENSE)
[![CADET version compatibility](https://github.com/cadet/CADET-Metapackage/actions/workflows/test_compatibility.yml/badge.svg)](https://github.com/cadet/CADET-Metapackage/actions/workflows/test_compatibility.yml)

# CADET Platform Metapackage

This package is a **metapackage** for the CADET platform.

It does not provide any importable Python modules itself.
Its only purpose is to install a curated set of CADET Python packages.

## Default packages

Installing `cadet` will install the following packages:

* **CADET-Process**
  Process analysis, optimization, and design toolkit
  PyPI: [https://pypi.org/project/cadet-process/](https://pypi.org/project/cadet-process/)
  Repository: [https://github.com/cadet/CADET-Process](https://github.com/cadet/CADET-Process)

* **CADET-Python**
  Python interface for CADET
  Installed as a dependency of `cadet-process`
  PyPI: [https://pypi.org/project/cadet-python/](https://pypi.org/project/cadet-python/)
  Repository: [https://github.com/cadet/CADET-Python](https://github.com/cadet/CADET-Python)

## Installation

Install the CADET platform metapackage:

```
pip install cadet
```

## Optional dependencies

Install the CADET metapackage plus research data management support:

```
pip install "cadet[rdm]"
```

This additionally installs:

* **CADET-RDM**
  Research data management utilities
  PyPI: [https://pypi.org/project/cadet-rdm/](https://pypi.org/project/cadet-rdm/)
  Repository: [https://github.com/cadet/CADET-RDM](https://github.com/cadet/CADET-RDM)

## Full platform bundle

Install the full platform bundle (currently identical to `cadet[rdm]`):

```
pip install "cadet[all]"
```

The `all` extra exists as a stable entry point if additional optional components are added in the future.

## Important notes

* This is a **metapackage only**.
  There is no `cadet` Python module to import.

* **Do not depend on `cadet` in other Python packages.**
  If you are developing a library, depend directly on the specific CADET components you use, such as `cadet-process` or `cadet-python`.

* This metapackage installs `cadet-core` from PyPI as part of the curated CADET stack.
  Alternative installation channels (for example conda-forge) may also be used if desired.

## Documentation and support

General CADET documentation and project information can be found at:

* [https://www.cadet.github.io](https://www.cadet.github.io)
* [https://github.com/cadet](https://github.com/cadet)

## Contributing and releases

For maintainers and contributors, including details on version management, CI workflows, and the release process, see:

* [`CONTRIBUTING.md`](CONTRIBUTING.md)
