CADET-Equations

CADET-Equations is a Python tool designed to generate modeling equations for packed-bed chromatography.
It provides a simple user interface that allows users to configure the model, and outputs the corresponding mathematical equations in LaTeX format.

Installation

To get started with CADET-Equations, you need to install the required Python dependencies and a LaTeX compiler.

Step 1: Install Python Dependencies

First, create a virtual environment (optional but recommended) and activate it. This will help to keep your Python dependencies isolated.

# Create a virtual environment (optional)
python3 -m venv venv

# Activate the virtual environment
source venv/bin/activate  # On Linux/macOS
venv\Scripts\activate     # On Windows

Next, install the necessary Python packages using conda or pip by running the following command:

# Install dependencies from requirements.yml
conda env create -f requirements.yml

If you are using pip instead of conda, make sure to create a requirements.txt file from requirements.yml, and install the dependencies with:

# If you use pip
pip install -r requirements.txt

Step 2: Install LaTeX Compiler

CADET-Equations requires a LaTeX compiler to generate mathematical equations in LaTeX format. If you are using a Linux-based system, you can install the necessary LaTeX packages using the following command:

# Install LaTeX compiler
sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra

This will install the required LaTeX components needed to render equations properly.

Usage

Once you have installed the necessary dependencies, you can use the tool to generate packed-bed chromatography modeling equations.

# Run the tool (replace with your script or command)
streamlit run Equation-Generator.py

Notes

• Ensure that the LaTeX compiler is correctly installed and accessible from your terminal.
• If you encounter any issues with LaTeX rendering, check the LaTeX installation or adjust configurations as needed.

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0) - see the LICENSE file for details.