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.

https://github.com/cadet/cadet-equations

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

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.

Basic Info
  • Host: GitHub
  • Owner: cadet
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 633 KB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 1
  • Open Issues: 12
  • Releases: 0
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

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

Create a new Conda environment with Python 3.10:

```bash conda create -n cadet-equations python=3.10

Next, install the necessary Python packages using pip by running the following commands:

```bash conda activate cadet-equations

conda install 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:

```bash

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.

```bash

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.

Owner

  • Name: CADET
  • Login: cadet
  • Kind: organization
  • Email: cadet@fz-juelich.de

GitHub Events

Total
  • Issues event: 22
  • Delete event: 6
  • Issue comment event: 10
  • Push event: 72
  • Public event: 1
  • Pull request event: 15
  • Fork event: 1
  • Create event: 7
Last Year
  • Issues event: 22
  • Delete event: 6
  • Issue comment event: 10
  • Push event: 72
  • Public event: 1
  • Pull request event: 15
  • Fork event: 1
  • Create event: 7

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 36
  • Total Committers: 1
  • Avg Commits per committer: 36.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 36
  • Committers: 1
  • Avg Commits per committer: 36.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jan Breuer j****r@g****e 36
Committer Domains (Top 20 + Academic)
gmx.de: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 19
  • Total pull requests: 8
  • Average time to close issues: 17 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.38
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 19
  • Pull requests: 8
  • Average time to close issues: 17 days
  • Average time to close pull requests: 6 days
  • Issue authors: 4
  • Pull request authors: 1
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.38
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jbreue16 (16)
  • schmoelder (1)
  • sleweke-bayer (1)
  • angela-moser (1)
Pull Request Authors
  • jbreue16 (14)
Top Labels
Issue Labels
enhancement (8) model (4) improvement (2) bug (2) documentation (1) test (1) interface (1)
Pull Request Labels
enhancement (9) documentation (2) improvement (2) model (2) bug (1)

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • conda-incubator/setup-miniconda v2 composite
environment.yml pypi