cadet / CADET-Core

A modular, fast, and accurate simulation framework for (bio)chemical processes
Other
65 stars 26 forks source link
cadet chromatography chromatography-analysis general-rate-model simulator

CADET

.. image:: https://img.shields.io/github/release/cadet/cadet-core.svg :target: https://github.com/cadet/cadet-core/releases

.. image:: https://github.com/cadet/cadet-core/actions/workflows/ci.yml/badge.svg?branch=master :target: https://github.com/cadet/cadet-core/actions/workflows/ci.yml?query=branch%3Amaster

.. image:: https://anaconda.org/conda-forge/cadet/badges/downloads.svg :target: https://anaconda.org/conda-forge/cadet

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8179015.svg :target: https://doi.org/10.5281/zenodo.8179015

.. image:: https://img.shields.io/badge/JuRSE_Code_Pick-Oct_2024-blue.svg :target: https://www.fz-juelich.de/en/rse/community-initiatives/jurse-code-of-the-month/october-2024

Installation

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

conda install -c conda-forge cadet

This requires a working conda installation <https://docs.anaconda.com/anaconda/install/index.html>_.

Optionally, use mamba <https://github.com/mamba-org/mamba>_ which uses a faster dependency solver than conda.

mamba install -c conda-forge cadet

Additional information <https://cadet.github.io/master/getting_started/installation>_ and a tutorial <https://cadet.github.io/master/getting_started/tutorials/breakthrough>_ are available to guide you through the installation and the first steps of using CADET.

Citing

The development of CADET 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 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 acknowledge its creators and their contributions by citing an adequate selection of our publications.

General:

Numerics:

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

Selected applications that demonstrate the capabilities and use-cases of CADET are highlighted in the documentation <https://cadet.github.io>_.

Ongoing Development

We do our best to provide you with a stable API. However, CADET 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 <https://github.com/cadet/cadet-core/issues>. Or, even better, fork the repository on GitHub <https://github.com/cadet/cadet-core> and create a pull request (PR) with the fix.

Donations

Donations <https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FCQ2M89558ZAG>_ for helping to host, maintain, and further develop the CADET project are highly appreciated.

License

Released under GPL v3. License (see LICENSE.txt <https://github.com/cadet/cadet-core/blob/master/LICENSE.txt>_)::

Acknowledgments

Please refer to the list of contributors <https://github.com/cadet/cadet-core/blob/master/CONTRIBUTING.md>_ who helped building and funding this project.

Copyright (C) 2004-2024 CADET Authors