You're reading the documentation for a development version. For the latest released version, please have a look at v5.0.3.

_images/cadet_logo.png

https://img.shields.io/github/release/cadet/cadet-core.svg https://github.com/cadet/cadet-core/actions/workflows/ci.yml/badge.svg?branch=master https://anaconda.org/conda-forge/cadet/badges/downloads.svg https://zenodo.org/badge/DOI/10.5281/zenodo.8179015.svg https://img.shields.io/badge/JuRSE_Code_Pick-Oct_2024-blue.svg

CADET-Core

CADET is developed at the Institute of Bio- and Geosciences 1 (IBG-1) of Forschungszentrum Jülich (FZJ) under supervision of Prof. Eric von Lieres. The heart of the CADET software is CADET-Core, a fast and accurate solver for a comprehensive model family. Typical applications include (but are by far not limited to) chromatography, filtration, crystallization, and fermentation. CADET-Core can handle arbitrary sequences and networks of unit operations, including reactors, tanks, tubes, pumps, valves, detectors, etc. The resulting models are solved with state-of-the-art mathematical algorithms and scientific computing techniques.

Features

  • Fast and accurate solution of strongly coupled partial differential algebraic equations (PDAE)

  • Computation of parameter sensitivities with algorithmic differentiation (AD)

  • Shared memory parallelization using Intel TBB

  • Python interface

  • Support of HDF5 and XML data formats

  • Flexible and extensible through modular design

  • Works on Windows, Linux, and Mac OS X

Installation

CADET-Core can be installed via conda from the conda-forge channel.

conda install -c conda-forge cadet

This requires a working conda installation.

Optionally, use mamba which uses a faster dependency solver than conda.

mamba install -c conda-forge cadet

For more information on how to install and build CADET, see here.

Ongoing Development

We do our best to provide you with a stable API. However, CADET-Core is actively developed and breaking changes can sometimes be unavoidable. For non-developers, it is recommended to upgrade from release to release instead of always working with the most recent commit.

Bugs

Please report any bugs that you find here. Or, even better, fork the repository on GitHub and create a pull request (PR) with the fix.

Donations

Donations for helping to host, maintain, and further develop the CADET-Core project are highly appreciated.

Citing

The development of CADET-Core has been a collaborative effort, with multiple dedicated individuals contributing their expertise to create a powerful and versatile open-source software tool. Countless hours of hard work have been invested to provide the scientific community with a valuable resource. As an open-source project, CADET-Core relies on the support and recognition from users and researchers to thrive. Therefore, we kindly ask that any publications or projects leveraging the capabilities of CADET-Core acknowledge its creators and their contributions by citing an adequate selection of our publications.

General:

Major extensions:

Additionally, to ensure reproducibility of your work, we recommend citing the zenodo doi corresponding to the specific CADET-Core release that you used.

For a comprehensive list and guidance on citing CADET-Core publications, please refer to the publications section of the documentation.

Acknowledgments

Please refer to the list of authors and contributors who helped building and funding this project.