Metadata-Version: 2.4
Name: sorbflow
Version: 0.3.0
Summary: Configurable aqueous adsorption modelling: batch and fixed-bed LDF/HSDM simulation, calibration, uncertainty and design
Author: Karel Aldrin Sanchez Hernandez, David Esteban Rodriguez Saiz, Dayana Ximena Cabrera Obando, Gabriela Johana Romo Cadena
Maintainer: Karel Aldrin Sanchez Hernandez
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/karelsanchez/SorbFlow
Project-URL: Documentation, https://sorbflow.readthedocs.io
Project-URL: Repository, https://github.com/karelsanchez/SorbFlow
Project-URL: Issues, https://github.com/karelsanchez/SorbFlow/issues
Project-URL: Changelog, https://github.com/karelsanchez/SorbFlow/blob/main/CHANGELOG.md
Keywords: adsorption,water treatment,fixed-bed,breakthrough curve,LDF,HSDM,isotherm,simulation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Natural Language :: Spanish
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: pint<0.26,>=0.24
Requires-Dist: numpy<3,>=1.26
Requires-Dist: scipy<2,>=1.12
Provides-Extra: dev
Requires-Dist: pytest<10,>=8; extra == "dev"
Requires-Dist: pytest-cov<8,>=5; extra == "dev"
Requires-Dist: ruff<1,>=0.9; extra == "dev"
Requires-Dist: mypy<2,>=1.14; extra == "dev"
Requires-Dist: build<2,>=1; extra == "dev"
Requires-Dist: scipy-stubs<2,>=1.14; extra == "dev"
Requires-Dist: ezdxf<2,>=1.3; extra == "dev"
Provides-Extra: optimize
Requires-Dist: pymoo<0.7,>=0.6.1; extra == "optimize"
Provides-Extra: parquet
Requires-Dist: pyarrow<27,>=17; extra == "parquet"
Dynamic: license-file

# SorbFlow

**SorbFlow** es una herramienta en Python para modelar, simular, calibrar y diseñar
procesos de adsorción en fase acuosa, en reactores batch y en columnas de lecho fijo.

```bash
pip install sorbflow                 # núcleo
pip install "sorbflow[optimize]"     # + optimización multiobjetivo NSGA-II
pip install "sorbflow[parquet]"      # + exportación Parquet
```

## Qué hace

- **Equilibrio**: isotermas lineal, Langmuir y Freundlich, con derivadas analíticas.
- **Cinética y transporte**: fuerza impulsora lineal (LDF) y difusión superficial
  homogénea (HSDM) con resistencia de película, dispersión axial y condiciones de
  frontera de Danckwerts.
- **Motores numéricos**: volúmenes finitos conservativos en el eje del lecho y en el
  radio de la partícula, integradores rígidos BDF/Radau, Jacobiano analítico disperso
  y modo *streaming* de baja memoria.
- **Calibración e incertidumbre**: ajuste de isotermas y constantes cinéticas,
  diagnósticos SVD, perfiles de verosimilitud, objetivos multiensayo, Monte Carlo
  con semilla y sensibilidad local.
- **Diseño**: EBCT, pérdida de carga de Ergun, potencia de bombeo, costo de operación,
  envolvente DXF y optimización multiobjetivo con restricciones.
- **Trazabilidad**: cada resultado guarda configuración, unidades, versiones, revisión
  del código, balance de masa y huellas SHA-256.
- **Tres formas de uso** sobre el mismo motor: API Python, comando `sorbflow` e
  interfaz web local (`python -m sorbflow.web`).

Cualquier soluto, adsorbente o mezcla de N componentes se describe como datos de
configuración, con unidades SI explícitas.

## Uso rápido

```bash
sorbflow column column_ldf.json --output resultados --cells 100
```

```python
from pathlib import Path
from sorbflow import SimulationConfig
from sorbflow.simulate import column
from sorbflow.solvers import SolverOptions

config = SimulationConfig.from_json(Path("column_ldf.json").read_text())
result = column(config, options=SolverOptions(axial_cells=200, jacobian="analytic"))
print(result.outlet_concentration_kg_m3[-1])
```

Las configuraciones de ejemplo (`batch_ldf.json`, `column_ldf.json`,
`column_hsdm.json`) están en la carpeta `examples/` del repositorio.

## Modelo de columna (resumen)

```text
ε ∂c/∂t + ρ_b ∂q̄/∂t = −∂J/∂z,     J = u c − ε D_ax ∂c/∂z
LDF:   ∂q̄/∂t = k_LDF [q*(c) − q̄]
HSDM:  ∂q/∂t = D_s r⁻² ∂/∂r (r² ∂q/∂r),   ρ_p D_s ∂q/∂r|_R = k_f (c − c_s)
```

## Calidad

588 pruebas automatizadas; integración continua en Windows y Linux con Python 3.11,
3.12 y 3.13; verificación frente a soluciones de referencia; documentación construida
en modo estricto.

## Documentación, cita y licencia

- Documentación: https://sorbflow.readthedocs.io
- Autores: Karel Aldrin Sanchez Hernandez, David Esteban Rodriguez Saiz,
  Dayana Ximena Cabrera Obando y Gabriela Johana Romo Cadena.
- Cita: archivo `CITATION.cff` del repositorio.
- Licencia: Apache-2.0.
