sorbflow 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sorbflow-0.3.0/.readthedocs.yaml +20 -0
- sorbflow-0.3.0/API_REFERENCE.md +132 -0
- sorbflow-0.3.0/ARCHITECTURE.md +123 -0
- sorbflow-0.3.0/CHANGELOG.md +66 -0
- sorbflow-0.3.0/CITATION.cff +33 -0
- sorbflow-0.3.0/CONTRIBUTORS.md +15 -0
- sorbflow-0.3.0/IMPLEMENTATION_NOTES.md +138 -0
- sorbflow-0.3.0/INICIAR_GUI.cmd +11 -0
- sorbflow-0.3.0/LICENSE +202 -0
- sorbflow-0.3.0/LICENSE.md +16 -0
- sorbflow-0.3.0/MANIFEST.in +17 -0
- sorbflow-0.3.0/MODEL_SPECIFICATION.md +134 -0
- sorbflow-0.3.0/NOTICE +12 -0
- sorbflow-0.3.0/PKG-INFO +121 -0
- sorbflow-0.3.0/PYPI_README.md +74 -0
- sorbflow-0.3.0/README.md +217 -0
- sorbflow-0.3.0/benchmarks/e01/README.md +53 -0
- sorbflow-0.3.0/benchmarks/e01/protocol.json +96 -0
- sorbflow-0.3.0/benchmarks/e01/run.py +704 -0
- sorbflow-0.3.0/benchmarks/e01b/README.md +57 -0
- sorbflow-0.3.0/benchmarks/e01b/protocol.json +38 -0
- sorbflow-0.3.0/benchmarks/e01b/reference.py +147 -0
- sorbflow-0.3.0/benchmarks/e01b/run.py +444 -0
- sorbflow-0.3.0/docs/analytic_jacobian.md +33 -0
- sorbflow-0.3.0/docs/api_generated.md +44 -0
- sorbflow-0.3.0/docs/assets/figures/batch_kinetics.png +0 -0
- sorbflow-0.3.0/docs/assets/figures/breakthrough_ldf_hsdm.png +0 -0
- sorbflow-0.3.0/docs/assets/figures/isotherms.png +0 -0
- sorbflow-0.3.0/docs/assets/figures/mesh_refinement.png +0 -0
- sorbflow-0.3.0/docs/assets/figures/performance.png +0 -0
- sorbflow-0.3.0/docs/assets/javascripts/mathjax.js +19 -0
- sorbflow-0.3.0/docs/batch_objective.md +38 -0
- sorbflow-0.3.0/docs/benchmark_results.md +86 -0
- sorbflow-0.3.0/docs/capabilities.md +57 -0
- sorbflow-0.3.0/docs/citation.md +43 -0
- sorbflow-0.3.0/docs/comparison.md +47 -0
- sorbflow-0.3.0/docs/configurations.md +76 -0
- sorbflow-0.3.0/docs/data_preparation.md +90 -0
- sorbflow-0.3.0/docs/developer_workflow.md +76 -0
- sorbflow-0.3.0/docs/documentation_site.md +59 -0
- sorbflow-0.3.0/docs/e04_integration.md +65 -0
- sorbflow-0.3.0/docs/engines.md +141 -0
- sorbflow-0.3.0/docs/examples_gallery.md +27 -0
- sorbflow-0.3.0/docs/faq.md +52 -0
- sorbflow-0.3.0/docs/figures.md +50 -0
- sorbflow-0.3.0/docs/getting_started.md +62 -0
- sorbflow-0.3.0/docs/index.md +77 -0
- sorbflow-0.3.0/docs/inverse_study_plan.md +216 -0
- sorbflow-0.3.0/docs/models.md +154 -0
- sorbflow-0.3.0/docs/observation_operators.md +53 -0
- sorbflow-0.3.0/docs/performance.md +40 -0
- sorbflow-0.3.0/docs/profile_batch_example.md +28 -0
- sorbflow-0.3.0/docs/profile_likelihood.md +143 -0
- sorbflow-0.3.0/docs/requirements.txt +36 -0
- sorbflow-0.3.0/docs/scientific_status.md +99 -0
- sorbflow-0.3.0/docs/streaming_integration.md +43 -0
- sorbflow-0.3.0/docs/tutorials.md +77 -0
- sorbflow-0.3.0/docs/web_interface.md +89 -0
- sorbflow-0.3.0/examples/batch_ldf.json +22 -0
- sorbflow-0.3.0/examples/column_hsdm.json +35 -0
- sorbflow-0.3.0/examples/column_ldf.json +34 -0
- sorbflow-0.3.0/examples/configuration.py +27 -0
- sorbflow-0.3.0/examples/e02_execution_kit.py +192 -0
- sorbflow-0.3.0/examples/linear_matrix_reference.py +160 -0
- sorbflow-0.3.0/examples/numerical_benchmarks.py +110 -0
- sorbflow-0.3.0/examples/profile_batch.py +102 -0
- sorbflow-0.3.0/examples/robust_column_design.py +118 -0
- sorbflow-0.3.0/examples/run_ldf.py +38 -0
- sorbflow-0.3.0/examples/scientific_demo.py +132 -0
- sorbflow-0.3.0/mkdocs.yml +145 -0
- sorbflow-0.3.0/pyproject.toml +78 -0
- sorbflow-0.3.0/scripts/build_docs.py +103 -0
- sorbflow-0.3.0/scripts/check_doc_links.py +174 -0
- sorbflow-0.3.0/scripts/make_figures.py +212 -0
- sorbflow-0.3.0/scripts/project_checks.py +131 -0
- sorbflow-0.3.0/scripts/software_manifest.py +246 -0
- sorbflow-0.3.0/setup.cfg +4 -0
- sorbflow-0.3.0/src/sorbflow/__init__.py +41 -0
- sorbflow-0.3.0/src/sorbflow/__main__.py +5 -0
- sorbflow-0.3.0/src/sorbflow/_arrays.py +40 -0
- sorbflow-0.3.0/src/sorbflow/_version.py +3 -0
- sorbflow-0.3.0/src/sorbflow/adapters/__init__.py +1 -0
- sorbflow-0.3.0/src/sorbflow/calibration/__init__.py +5 -0
- sorbflow-0.3.0/src/sorbflow/calibration/batch_objective.py +118 -0
- sorbflow-0.3.0/src/sorbflow/calibration/least_squares.py +207 -0
- sorbflow-0.3.0/src/sorbflow/calibration/measurements.py +49 -0
- sorbflow-0.3.0/src/sorbflow/calibration/profile.py +327 -0
- sorbflow-0.3.0/src/sorbflow/cli.py +64 -0
- sorbflow-0.3.0/src/sorbflow/design/__init__.py +6 -0
- sorbflow-0.3.0/src/sorbflow/design/cad.py +65 -0
- sorbflow-0.3.0/src/sorbflow/design/hydraulics.py +99 -0
- sorbflow-0.3.0/src/sorbflow/equilibrium/__init__.py +17 -0
- sorbflow-0.3.0/src/sorbflow/equilibrium/isotherms.py +117 -0
- sorbflow-0.3.0/src/sorbflow/fit.py +7 -0
- sorbflow-0.3.0/src/sorbflow/io/__init__.py +7 -0
- sorbflow-0.3.0/src/sorbflow/io/experimental.py +159 -0
- sorbflow-0.3.0/src/sorbflow/io/parquet.py +79 -0
- sorbflow-0.3.0/src/sorbflow/io/results.py +50 -0
- sorbflow-0.3.0/src/sorbflow/kinetics/__init__.py +5 -0
- sorbflow-0.3.0/src/sorbflow/kinetics/sphere.py +112 -0
- sorbflow-0.3.0/src/sorbflow/observation.py +174 -0
- sorbflow-0.3.0/src/sorbflow/optimization/__init__.py +5 -0
- sorbflow-0.3.0/src/sorbflow/optimization/nsga2.py +161 -0
- sorbflow-0.3.0/src/sorbflow/optimize.py +5 -0
- sorbflow-0.3.0/src/sorbflow/py.typed +0 -0
- sorbflow-0.3.0/src/sorbflow/reactors/__init__.py +6 -0
- sorbflow-0.3.0/src/sorbflow/reactors/_ldf_jacobian.py +58 -0
- sorbflow-0.3.0/src/sorbflow/reactors/batch.py +87 -0
- sorbflow-0.3.0/src/sorbflow/reactors/column.py +151 -0
- sorbflow-0.3.0/src/sorbflow/reactors/hsdm.py +167 -0
- sorbflow-0.3.0/src/sorbflow/schemas.py +496 -0
- sorbflow-0.3.0/src/sorbflow/simulate.py +6 -0
- sorbflow-0.3.0/src/sorbflow/solvers/__init__.py +7 -0
- sorbflow-0.3.0/src/sorbflow/solvers/integration.py +152 -0
- sorbflow-0.3.0/src/sorbflow/solvers/options.py +74 -0
- sorbflow-0.3.0/src/sorbflow/solvers/results.py +318 -0
- sorbflow-0.3.0/src/sorbflow/uncertainty/__init__.py +5 -0
- sorbflow-0.3.0/src/sorbflow/uncertainty/monte_carlo.py +129 -0
- sorbflow-0.3.0/src/sorbflow/units.py +53 -0
- sorbflow-0.3.0/src/sorbflow/validate/__init__.py +35 -0
- sorbflow-0.3.0/src/sorbflow/web/__init__.py +5 -0
- sorbflow-0.3.0/src/sorbflow/web/__main__.py +6 -0
- sorbflow-0.3.0/src/sorbflow/web/app.py +278 -0
- sorbflow-0.3.0/src/sorbflow/web/config.py +213 -0
- sorbflow-0.3.0/src/sorbflow/web/server.py +302 -0
- sorbflow-0.3.0/src/sorbflow/web/ui.py +50 -0
- sorbflow-0.3.0/src/sorbflow.egg-info/PKG-INFO +121 -0
- sorbflow-0.3.0/src/sorbflow.egg-info/SOURCES.txt +163 -0
- sorbflow-0.3.0/src/sorbflow.egg-info/dependency_links.txt +1 -0
- sorbflow-0.3.0/src/sorbflow.egg-info/entry_points.txt +2 -0
- sorbflow-0.3.0/src/sorbflow.egg-info/requires.txt +18 -0
- sorbflow-0.3.0/src/sorbflow.egg-info/top_level.txt +1 -0
- sorbflow-0.3.0/tests/conftest.py +21 -0
- sorbflow-0.3.0/tests/test_arrays.py +22 -0
- sorbflow-0.3.0/tests/test_batch.py +106 -0
- sorbflow-0.3.0/tests/test_batch_objective.py +90 -0
- sorbflow-0.3.0/tests/test_build_docs.py +94 -0
- sorbflow-0.3.0/tests/test_column.py +151 -0
- sorbflow-0.3.0/tests/test_column_analytic.py +139 -0
- sorbflow-0.3.0/tests/test_design.py +90 -0
- sorbflow-0.3.0/tests/test_doc_links.py +136 -0
- sorbflow-0.3.0/tests/test_e01_protocol.py +114 -0
- sorbflow-0.3.0/tests/test_e01b_reference.py +137 -0
- sorbflow-0.3.0/tests/test_e02_execution_kit.py +132 -0
- sorbflow-0.3.0/tests/test_e04_review_import.py +41 -0
- sorbflow-0.3.0/tests/test_equilibrium.py +76 -0
- sorbflow-0.3.0/tests/test_experimental_csv.py +108 -0
- sorbflow-0.3.0/tests/test_fit.py +97 -0
- sorbflow-0.3.0/tests/test_hsdm.py +151 -0
- sorbflow-0.3.0/tests/test_io_cli.py +114 -0
- sorbflow-0.3.0/tests/test_linear_matrix_reference.py +14 -0
- sorbflow-0.3.0/tests/test_observation.py +132 -0
- sorbflow-0.3.0/tests/test_observation_column.py +40 -0
- sorbflow-0.3.0/tests/test_optimize.py +65 -0
- sorbflow-0.3.0/tests/test_parquet.py +114 -0
- sorbflow-0.3.0/tests/test_profile.py +263 -0
- sorbflow-0.3.0/tests/test_project_checks.py +55 -0
- sorbflow-0.3.0/tests/test_schemas.py +251 -0
- sorbflow-0.3.0/tests/test_scientific_schemas.py +92 -0
- sorbflow-0.3.0/tests/test_signed_measurements.py +100 -0
- sorbflow-0.3.0/tests/test_software_manifest.py +284 -0
- sorbflow-0.3.0/tests/test_streaming.py +164 -0
- sorbflow-0.3.0/tests/test_uncertainty.py +67 -0
- sorbflow-0.3.0/tests/test_units.py +56 -0
- sorbflow-0.3.0/tests/test_web.py +367 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Read the Docs build for SorbFlow (MkDocs + Material + mkdocstrings).
|
|
2
|
+
version: 2
|
|
3
|
+
build:
|
|
4
|
+
os: ubuntu-24.04
|
|
5
|
+
tools:
|
|
6
|
+
python: "3.12"
|
|
7
|
+
jobs:
|
|
8
|
+
post_checkout:
|
|
9
|
+
# build_docs.py stages only git-indexed files; make sure history is complete.
|
|
10
|
+
- git fetch --unshallow || true
|
|
11
|
+
post_install:
|
|
12
|
+
- python scripts/build_docs.py --prepare-only
|
|
13
|
+
mkdocs:
|
|
14
|
+
configuration: mkdocs.yml
|
|
15
|
+
fail_on_warning: true
|
|
16
|
+
python:
|
|
17
|
+
install:
|
|
18
|
+
- requirements: docs/requirements.txt
|
|
19
|
+
- method: pip
|
|
20
|
+
path: .
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# API pública — SorbFlow 0.3
|
|
2
|
+
|
|
3
|
+
Guía narrativa de la API. Visión general de cada motor en
|
|
4
|
+
[motores de cálculo](docs/engines.md); referencia generada del código en
|
|
5
|
+
[API generada](docs/api_generated.md).
|
|
6
|
+
|
|
7
|
+
Python >=3.11, unidades SI y masa seca. Se conservan las API de datos de 0.1;
|
|
8
|
+
`Linear` se añade como variante del esquema v1. Un lector antiguo no entenderá esa
|
|
9
|
+
variante nueva; los archivos antiguos siguen siendo legibles. No hay migración implícita.
|
|
10
|
+
|
|
11
|
+
## Datos y unidades
|
|
12
|
+
|
|
13
|
+
Desde `sorbflow`: `quantity`, `to_si`, `UnitError`, `Species`, `Bed`, `Operation`,
|
|
14
|
+
`Langmuir`, `Freundlich`, `Linear`, `LDF`, `HSDM`, `SimulationConfig`, `BatchConfig`,
|
|
15
|
+
`Observations`, `RunManifest`, `BlendComponent`, `AdsorbentBlend`.
|
|
16
|
+
Constructores SI validan rangos/tipos; dataclasses congeladas. Las fábricas dimensionales
|
|
17
|
+
`Bed.from_quantities` y `Operation.from_quantities` convierten Pint a SI.
|
|
18
|
+
Configuraciones soportan `to_json`, `from_json`, `sha256`; claves duplicadas o desconocidas
|
|
19
|
+
se rechazan. Blend tiene `to_json` y N componentes de fracción másica seca positiva,
|
|
20
|
+
suma uno y nombres distintos, sin ley de mezcla implícita.
|
|
21
|
+
|
|
22
|
+
## Equilibrio
|
|
23
|
+
|
|
24
|
+
`sorbflow.equilibrium.isotherm_from_parameters(parameters)` construye un `Isotherm`.
|
|
25
|
+
`loading(c)` devuelve kg/kg y `derivative(c)` devuelve m³/kg conservando la forma
|
|
26
|
+
del array de entrada. c se expresa en kg/m³, no puede ser negativo, NaN o infinito.
|
|
27
|
+
Langmuir, Freundlich normalizado y lineal implementan el protocolo. Freundlich con
|
|
28
|
+
exponente<1 informa derivada singular en c=0; no la regulariza.
|
|
29
|
+
Temperatura fija: parámetros deben corresponder a la temperatura del ensayo.
|
|
30
|
+
|
|
31
|
+
## Simulación
|
|
32
|
+
|
|
33
|
+
`sorbflow.simulate.batch(BatchConfig, time_s=None, options=None, code_revision='uncommitted')`
|
|
34
|
+
resuelve dos estados LDF en batch cerrado.
|
|
35
|
+
`sorbflow.simulate.column(SimulationConfig, ...)` selecciona LDF o HSDM de forma explícita.
|
|
36
|
+
HSDM agrega difusión radial esférica y película; no incluye agua intrapartícula.
|
|
37
|
+
|
|
38
|
+
`SolverOptions` en `sorbflow.solvers`: BDF/Radau, rtol, tolerancias absolutas separadas
|
|
39
|
+
de c, q y masa, tolerancia relativa/escala de masa, max_step_s, axial_cells y radial_cells.
|
|
40
|
+
`time_s` es una malla de observación estrictamente creciente desde 0 hasta duración;
|
|
41
|
+
no prescribe los pasos internos. Por defecto son 201 observaciones.
|
|
42
|
+
Fallos de integración, estados no finitos, negatividad superior a diez atol o balance
|
|
43
|
+
fuera de tolerancia generan `SimulationError`, sin reparar ni recortar los resultados.
|
|
44
|
+
|
|
45
|
+
`SimulationResult`: arrays de c y carga media con forma (tiempo, celda axial), inventario
|
|
46
|
+
y masas acumuladas, centros z, diagnósticos en pasos internos y salidas, configuración,
|
|
47
|
+
opciones, `numerical_sha256` y manifiesto con versiones/UUID/UTC/revisión. Batch tiene
|
|
48
|
+
una celda. HSDM agrega `radial_loading_kg_kg` (tiempo, axial, radial) y `r_m`.
|
|
49
|
+
`outlet_concentration_kg_m3` es última celda FV o líquido batch. Arrays son snapshots
|
|
50
|
+
de solo lectura. `to_json` conserva datos/unidades; ningún resultado afirma validación
|
|
51
|
+
experimental. La revisión Git se aporta explícitamente; el valor por defecto indica
|
|
52
|
+
estado no congelado. La huella numérica incluye configuración, opciones, tipo y tiempos;
|
|
53
|
+
las versiones se guardan en el manifiesto.
|
|
54
|
+
|
|
55
|
+
`sorbflow.io.export_result(result, nueva_carpeta)` escribe JSON, CSV de salida/balance
|
|
56
|
+
y huellas de archivos. Rechaza carpetas existentes. La CLI `python -m sorbflow` acepta
|
|
57
|
+
`batch|column`, configuración JSON y `--output`; opciones `--cells`, `--radial-cells`,
|
|
58
|
+
`--method`, `--rtol`, `--samples`, `--code-revision`.
|
|
59
|
+
|
|
60
|
+
## Ajuste inverso
|
|
61
|
+
|
|
62
|
+
`sorbflow.fit.isotherm(c, q, initial, std_loading_kg_kg=None, max_nfev=1000)` estima
|
|
63
|
+
parámetros positivos con least_squares en log-coordenadas. Freundlich conserva c_ref.
|
|
64
|
+
`sorbflow.fit.batch_rate(config, observations, max_nfev=100)` estima solo k_LDF.
|
|
65
|
+
Condiciones, equilibrio, identidad de especie y tiempos deben ser coherentes.
|
|
66
|
+
No admite datos censurados ni errores en las concentraciones de equilibrio.
|
|
67
|
+
|
|
68
|
+
`FitResult` contiene parámetros, predicciones/residuales, SVD, rango/condición y
|
|
69
|
+
covarianza local en log-parámetros (None si rango/condición no son adecuados).
|
|
70
|
+
`locally_identifiable` no establece identificabilidad global. Con sigma conocida
|
|
71
|
+
se usa su modelo de error; sin ella se estima varianza residual con grados de libertad.
|
|
72
|
+
Un optimizador no convergente produce FitError, no un resultado exitoso.
|
|
73
|
+
|
|
74
|
+
## Incertidumbre y sensibilidad
|
|
75
|
+
|
|
76
|
+
`sorbflow.uncertainty.monte_carlo(evaluate, sampler, n_samples, seed, model_id, probabilities)`
|
|
77
|
+
usa Generator local y registra muestras SI, salidas, media, desviación, error estándar
|
|
78
|
+
de la media y cuantiles. El sampler recibe (Generator,n) y devuelve matriz (n,p);
|
|
79
|
+
evaluate recibe un vector p y devuelve escalar/vector. Un fallo aborta con índice,
|
|
80
|
+
sin condicionar sobre casos sobrevivientes. El usuario preserva código del muestreador,
|
|
81
|
+
correlaciones e identidad del modelo. Cuantiles de propagación no son automáticamente
|
|
82
|
+
intervalos de credibilidad o confianza con cobertura demostrada.
|
|
83
|
+
`local_sensitivity(evaluate, point_si, steps_si)` calcula Jacobiano central;
|
|
84
|
+
pasos por parámetro explícitos, sin cambios de frontera automáticos.
|
|
85
|
+
|
|
86
|
+
## Diseño y multiobjetivo
|
|
87
|
+
|
|
88
|
+
`sorbflow.design.hydraulics(bed, flow_m3_s, fluid_density_kg_m3, viscosity_pa_s, pump_efficiency)`
|
|
89
|
+
devuelve EBCT, residencia líquida, masa seca, pérdida Ergun, potencia y Re de partícula.
|
|
90
|
+
Se excluyen soporte, pared, forma no esférica, hinchamiento y ensuciamiento.
|
|
91
|
+
`cost_estimate(design, CostBasis(...), service_time_s)` suma adsorbente y electricidad
|
|
92
|
+
con precios, moneda/año declarados; no es costo de ciclo de vida.
|
|
93
|
+
`export_dxf(bed,path)` crea envolvente cilíndrica de proceso en metros, sin sobrescribir.
|
|
94
|
+
No calcula estructura, espesor ni accesorios; STEP requiere un adaptador posterior.
|
|
95
|
+
|
|
96
|
+
`sorbflow.optimize.nsga2(evaluate, lower_bounds_si, upper_bounds_si, objective_units,
|
|
97
|
+
variable_units, problem_id, seed, n_constraints=0, population_size=80, generations=100)`
|
|
98
|
+
usa el extra optativo pymoo. Evaluate devuelve `Evaluation(objectives, constraints)`;
|
|
99
|
+
todos los objetivos se minimizan y las restricciones normalizadas satisfacen g<=0.
|
|
100
|
+
Las unidades son metadatos explícitos del evaluador: no se convierten precios ni
|
|
101
|
+
funciones objetivo automáticamente. Se reevalúa cada punto final, se exige repetibilidad
|
|
102
|
+
y factibilidad y se registra la especificación/versiones. Para diseño robusto usar
|
|
103
|
+
escenarios congelados comunes entre candidatos. El usuario debe demostrar convergencia,
|
|
104
|
+
reevaluar en malla fina y ampliar escenarios antes de aceptar un diseño industrial.
|
|
105
|
+
|
|
106
|
+
`sorbflow.validate.mass_balance(result)` recalcula el cierre en tiempos exportados;
|
|
107
|
+
los diagnósticos del solver incluyen también pasos internos. No es validación física.
|
|
108
|
+
|
|
109
|
+
## CSV experimental y Parquet opcional
|
|
110
|
+
|
|
111
|
+
`sorbflow.io.load_breakthrough_csv(path, experiment_id, species_name, time_column, concentration_column, time_unit, concentration_unit, std_column=None, std_unit=None, delimiter=",")` exige argumentos nombrados y unidades. Devuelve Observations en SI con SHA-256 de bytes originales, BOM opcional y errores por fila/columna. Rechaza cabeceras repetidas, registros vacíos, censura no declarada y tiempos no ordenados; no limpia ni modifica el original. Columnas de metadatos adicionales quedan intactas en el CSV fuente y no se incluyen en Observations.
|
|
112
|
+
|
|
113
|
+
`export_parquet(result, destination)` usa el extra `[parquet]` (PyArrow), con importación perezosa. Guarda tabla temporal de salida y balance, unidades por campo y metadatos de configuración/opciones/manifiesto/diagnósticos/huella. No guarda perfiles completos: para ellos usar JSON. Rechaza sobrescritura mediante apertura exclusiva; un fallo I/O durante escritura puede dejar un archivo parcial nuevo.
|
|
114
|
+
|
|
115
|
+
## Interfaz local opcional
|
|
116
|
+
|
|
117
|
+
`python -m sorbflow.web --host 127.0.0.1 --port 8765 --output runs/gui` inicia un
|
|
118
|
+
servidor local que invoca los mismos esquemas y simuladores. No requiere extras
|
|
119
|
+
de interfaz. El contrato HTTP es interno de la interfaz local, no una API remota
|
|
120
|
+
estable. Flujo, límites y descargas: [guía de la GUI](docs/web_interface.md).
|
|
121
|
+
|
|
122
|
+
## Calibración experimental con sigma conocida
|
|
123
|
+
|
|
124
|
+
`sorbflow.calibration.profile.profile_gaussian_known_sigma` conserva multiinicios,
|
|
125
|
+
reoptimización de nuisance, fallos y presupuestos reales de callback. Su salida
|
|
126
|
+
es evidencia sobre una malla de parámetros positivos: no un intervalo continuo
|
|
127
|
+
ni una prueba de identificabilidad global. [Contrato](docs/profile_likelihood.md).
|
|
128
|
+
|
|
129
|
+
`sorbflow.calibration.batch_objective.LinearBatchObjective` conecta esa interfaz con
|
|
130
|
+
varios batches lineales/LDF y sigma declarada conocida. Comparte K/k entre ensayos
|
|
131
|
+
compatibles y cuenta intentos físicos de simulación. No sustituye la API existente
|
|
132
|
+
`batch_rate` ni implementa una likelihood censurada. [Contrato](docs/batch_objective.md).
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# SorbFlow — arquitectura
|
|
2
|
+
|
|
3
|
+
Fecha: 2026-11-18; actualizado 2026-11-20. Estado: SorbFlow 0.3, motor propio LDF/HSDM con verificación numérica (E01), calibración, incertidumbre, diseño, CLI e interfaz web local.
|
|
4
|
+
|
|
5
|
+
Diagrama de motores y flujo de datos en [motores de cálculo](docs/engines.md).
|
|
6
|
+
|
|
7
|
+
## Alcance y procedencia
|
|
8
|
+
|
|
9
|
+
Implementación independiente del balance de adsorción, sin derivar código de FAST.
|
|
10
|
+
El ZIP local de FAST 2.1 beta solo contiene ejecutables y ayuda gráfica; no permite
|
|
11
|
+
auditar su discretización, integradores ni optimización. Véase IP_LICENSE_AUDIT.md.
|
|
12
|
+
Los cinco documentos de diseño preceden a la implementación de unidades y esquemas.
|
|
13
|
+
|
|
14
|
+
## Decisiones
|
|
15
|
+
|
|
16
|
+
1. Python >=3.11, distribución con layout `src`, `pyproject.toml`, wheel/sdist,
|
|
17
|
+
anotaciones, `py.typed`, dataclasses congeladas y pytest. Sin estado global de ejecución.
|
|
18
|
+
2. Pint convierte magnitudes escalares al ingresar; los esquemas almacenan floats SI.
|
|
19
|
+
El núcleo numérico opera sobre arrays SI y recibirá parámetros explícitos.
|
|
20
|
+
No habrá conversiones silenciosas de concentración molar a másica ni de base húmeda a seca.
|
|
21
|
+
3. Dominio inicial: una especie acuosa, lecho uniforme, operación isotérmica, flujo
|
|
22
|
+
positivo constante, adsorción reversible, densidades en base seca. Extensiones
|
|
23
|
+
multicomponente y térmicas requieren nuevas versiones del contrato.
|
|
24
|
+
4. Solver propio significa balances, flujos, discretización, Jacobiano y diagnósticos
|
|
25
|
+
desarrollados aquí. Se reutilizarán integradores públicos de SciPy, no se escribirá
|
|
26
|
+
un integrador rígido desde cero. No se dependerá de FAST para resolver el modelo.
|
|
27
|
+
5. Ninguna dependencia del core importa ejecutables, plugins comerciales ni interfaces gráficas.
|
|
28
|
+
6. La API pública documentada se mantiene durante la serie 0.3 (el renombrado a
|
|
29
|
+
`sorbflow` abrió esa serie); cambios incompatibles requieren versión menor,
|
|
30
|
+
migración y advertencia. La estabilidad 1.0 es un hito posterior.
|
|
31
|
+
|
|
32
|
+
## Módulos y dirección de dependencias
|
|
33
|
+
|
|
34
|
+
| Módulo | Responsabilidad | Estado actual |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| `units` | Validación dimensional, escalares finitos, conversiones SI | Implementado |
|
|
37
|
+
| `schemas` | Especie, material, geometría, operación, observaciones, manifiestos | Implementado |
|
|
38
|
+
| `equilibrium` | Langmuir, Freundlich, lineal y derivadas | Implementado |
|
|
39
|
+
| `kinetics` | LDF y FV radial HSDM/película | Implementado |
|
|
40
|
+
| `reactors` | Batch LDF y columna LDF/HSDM | Implementado |
|
|
41
|
+
| `solvers` | FV e integración BDF/Radau con comprobaciones | Implementado |
|
|
42
|
+
| `calibration` | Ajuste inicial y diagnóstico local SVD | Implementado |
|
|
43
|
+
| `uncertainty` | Monte Carlo reproducible y sensibilidad local | Implementado |
|
|
44
|
+
| `optimization` | NSGA-II opcional y verificación de factibilidad | Implementado |
|
|
45
|
+
| `io` | JSON/CSV y huellas de resultados | Implementado |
|
|
46
|
+
| `adapters` | Interoperabilidad externa optativa y aislada | Reservado |
|
|
47
|
+
|
|
48
|
+
`units <- schemas <- modelos <- reactores <- solvers <- workflows`.
|
|
49
|
+
`io` y adaptadores dependen de contratos públicos; el núcleo nunca depende de ellos.
|
|
50
|
+
La fachada `sorbflow.simulate` ejecuta modelos propios; `fit`, `optimize`, `uncertainty`, `design` y `validate` son superficies públicas. API, CLI e interfaz web local (`sorbflow.web`) implementadas sobre el mismo núcleo.
|
|
51
|
+
|
|
52
|
+
## Contratos científicos y extensiones
|
|
53
|
+
|
|
54
|
+
Isotherm: `loading(c, temperature)` y derivada con unidades declaradas y dominio.
|
|
55
|
+
Kinetics: fuente de masa sólida, estados adicionales y parámetros validados.
|
|
56
|
+
Reactor: geometría, inventarios, flujos de frontera y condiciones iniciales.
|
|
57
|
+
Solver: problema discretizado + configuración -> resultado con estado de terminación,
|
|
58
|
+
balances acumulados, tolerancias, malla y diagnósticos; fallos no producen resultados exitosos.
|
|
59
|
+
Calibration: datos con incertidumbre y límites de detección, priors y parámetros
|
|
60
|
+
transformados; `fit` no equivale a validación externa.
|
|
61
|
+
Optimization: cada objetivo incluye unidades, dirección y tratamiento explícito de fallos;
|
|
62
|
+
soluciones no factibles nunca se promueven a Pareto válido.
|
|
63
|
+
|
|
64
|
+
## Datos y trazabilidad
|
|
65
|
+
|
|
66
|
+
Los esquemas iniciales usan nombres con sufijo SI (`length_m`, `flow_m3_s`, etc.).
|
|
67
|
+
Las fábricas `from_quantities` exigen magnitudes Pint dimensionales. El constructor
|
|
68
|
+
directo es una ruta SI explícita y valida rangos; rechaza bool, NaN e infinito.
|
|
69
|
+
Se fijan schema_version=1, modelos mediante uniones discriminadas, observaciones
|
|
70
|
+
inmutables y horas con zona. Un manifiesto registra UUID, commit, huellas SHA-256,
|
|
71
|
+
versiones y semilla. La serialización canónica produce huellas independientes del
|
|
72
|
+
orden de claves. La huella de configuración debe excluir UUID y fecha si se desea
|
|
73
|
+
comparar configuraciones; el manifiesto completo identifica una ejecución concreta.
|
|
74
|
+
El manifiesto inicial es un contrato manual: todavía no captura el entorno automáticamente.
|
|
75
|
+
|
|
76
|
+
Futuros resultados: configuración normalizada, datos originales referenciados por
|
|
77
|
+
hash, arrays con dimensiones y unidades, logs, revisión Git, entorno bloqueado,
|
|
78
|
+
algoritmos y criterios de parada. Guardar interrupciones y semillas por trabajador.
|
|
79
|
+
No versionar datos experimentales privados ni resultados voluminosos en el paquete.
|
|
80
|
+
|
|
81
|
+
## FAST opcional y propiedad intelectual
|
|
82
|
+
|
|
83
|
+
Un adaptador futuro aceptará una instalación aportada por el usuario, validará versión,
|
|
84
|
+
licencia y contrato de archivos, trabajará en un directorio temporal propio y no tocará
|
|
85
|
+
simulaciones existentes. No se distribuyen binarios ni ayuda FAST. Sin especificación
|
|
86
|
+
documentada de I/O ni autorización compatible, el adaptador queda sin implementar.
|
|
87
|
+
Comparar contra FAST será una prueba de compatibilidad, nunca la única validación.
|
|
88
|
+
|
|
89
|
+
Propuesta de core Apache-2.0 sujeta a aprobación del titular; no se atribuye ni concede
|
|
90
|
+
una licencia sin esa decisión. Componentes comerciales en repositorios y distribuciones
|
|
91
|
+
separados, conectados por contratos públicos. Los derechos sobre datos se controlan aparte.
|
|
92
|
+
|
|
93
|
+
## Calidad y distribución
|
|
94
|
+
|
|
95
|
+
CI en GitHub Actions: Linux/Windows, Python 3.11–3.13; pytest, cobertura, Ruff,
|
|
96
|
+
mypy y construcción de wheel y sdist. Las seis combinaciones aprobaron sobre el
|
|
97
|
+
commit `e0d3c01` (2026-11-20). Sin publicación automática ni credenciales.
|
|
98
|
+
Distribución `sorbflow`; import `sorbflow`.
|
|
99
|
+
Disponibilidad en PyPI y posibles marcas pendientes; no afirmar reserva del nombre.
|
|
100
|
+
|
|
101
|
+
Dependencias runtime del core: Pint, NumPy y SciPy. Desarrollo: pytest, pytest-cov, Ruff, mypy,
|
|
102
|
+
build y setuptools. NSGA-II usa pymoo como extra opcional; su dependencia moocore LGPL requiere revisión específica de distribución. UQ usa NumPy del core. No se cargan dependencias comerciales desde el core.
|
|
103
|
+
Rangos en pyproject para instalación; snapshot exacto del entorno para reproducibilidad local.
|
|
104
|
+
|
|
105
|
+
Referencias técnicas: [Pint](https://pint.readthedocs.io/en/stable/getting/tutorial.html),
|
|
106
|
+
[integración SciPy](https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.solve_ivp.html),
|
|
107
|
+
[empaquetado](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/).
|
|
108
|
+
|
|
109
|
+
## Ampliación acordada
|
|
110
|
+
|
|
111
|
+
La investigación de cuatro materiales es una primera aplicación, no un límite del producto. AdsorbentBlend admite N componentes sin una ley de mezcla implícita. Open Core propuesto: Apache-2.0 para core y distribución independiente sorbflow-design-pro; la titularidad universitaria se resuelve antes de conceder/publicar la licencia. El nombre de distribución actual sigue siendo provisional. Detalles de ecuaciones implementadas, patrones dispersos y flujo robusto en IMPLEMENTATION_NOTES.md.
|
|
112
|
+
|
|
113
|
+
## Objetivo editorial y cambios exigidos (2026-11-18)
|
|
114
|
+
|
|
115
|
+
El objetivo científico de SorbFlow es un framework publicable en Environmental Modelling & Software, condicionado a demostrar aporte y evaluar sus límites. PAPER_ENVSOFT contiene pregunta, matriz C01–C08, formulación y protocolo E01–E05; es la referencia para el estudio confirmatorio, sin cambiar retroactivamente lo que el prototipo ya verificó.
|
|
116
|
+
|
|
117
|
+
Cambios requeridos: contratos separados de problema físico, dominio validado, observación/likelihood, calibración multiexperimento, identificabilidad de parámetros y cantidades de decisión, fuentes de incertidumbre, riesgo y clasificación con error numérico. Agregar un registro de estudio/particiones/presupuesto y un ejecutor persistente de tareas por contenido con caché, reintentos, semillas jerárquicas y artefactos verificables. No representar estas propuestas como capacidades completas del prototipo.
|
|
118
|
+
|
|
119
|
+
Los checkpoints actuales del solver son arrays RAM para controles; no son reinicio persistente de BDF. El arnés PAPER_ENVSOFT/reproduce_smoke.py orquesta referencias/demos sintéticos y reutiliza tareas completas verificadas. No implementa distribución multinodo ni reanudación interna de optimizador/integrador, y no cierra E05.
|
|
120
|
+
|
|
121
|
+
La metodología debe definir qué acción produce cada diagnóstico; perfiles paramétricos abiertos no invalidan automáticamente una cantidad de decisión bien determinada. La búsqueda robusta y la validación probabilística usan conjuntos distintos. Un contador de candidatos NSGA-II no sustituye el costo total de solves físicos.
|
|
122
|
+
|
|
123
|
+
El caso de cuatro materiales se mantiene en un paquete de datos independiente. Ninguna función o script esencial para reproducir resultados centrales del artículo dependerá de una edición comercial. Apache-2.0 sigue condicionado a titularidad/licencia y acceso efectivos.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Registro de cambios
|
|
2
|
+
|
|
3
|
+
## 0.3.0 — SorbFlow, 2026-11-21
|
|
4
|
+
|
|
5
|
+
- Primera publicación en PyPI: `pip install sorbflow`. Publicación automática por
|
|
6
|
+
*trusted publishing* al publicar una release de GitHub (`.github/workflows/publish.yml`).
|
|
7
|
+
- Licencia **Apache-2.0** (`LICENSE`, `NOTICE`); titular K. A. Sanchez Hernandez.
|
|
8
|
+
- Autores: K. A. Sanchez Hernandez, D. E. Rodriguez Saiz, D. X. Cabrera Obando y
|
|
9
|
+
G. J. Romo Cadena; metadatos de cita en `CITATION.cff`.
|
|
10
|
+
- Documentación: modelos y ecuaciones (MathJax), motores de cálculo, comparación con
|
|
11
|
+
otras herramientas, galería de figuras generadas por `scripts/make_figures.py` y
|
|
12
|
+
diagrama de arquitectura.
|
|
13
|
+
- Distribución fuente reducida a código, pruebas, ejemplos, scripts y documentación.
|
|
14
|
+
|
|
15
|
+
## 0.3.0.dev0 — SorbFlow, 2026-11-20
|
|
16
|
+
|
|
17
|
+
- **Nuevo nombre: SorbFlow** (antes PyFAST). Distribución, paquete importable y
|
|
18
|
+
comando pasan a `sorbflow`; la interfaz local se inicia con `python -m sorbflow.web`.
|
|
19
|
+
Cambio incompatible de importación: sustituir `import pyfast` por `import sorbflow`.
|
|
20
|
+
- Resultados JSON con `result_schema_version: 2` y el campo `result_kind:
|
|
21
|
+
numerical_simulation`; metadatos Parquet con prefijo `sorbflow.`.
|
|
22
|
+
- Documentación reorganizada como herramienta general: capacidades, configuraciones,
|
|
23
|
+
rendimiento, galería de ejemplos, preguntas frecuentes y referencia de API generada.
|
|
24
|
+
- Read the Docs y CI reforzados: dependencias de documentación fijadas, construcción
|
|
25
|
+
estricta, caché, cancelación de ejecuciones obsoletas e instalación del wheel construido.
|
|
26
|
+
- La evidencia congelada (`audit/`, protocolos, captura de reproducción) conserva el
|
|
27
|
+
nombre anterior como registro histórico.
|
|
28
|
+
|
|
29
|
+
## Cambios locales sin publicar — 2026-11-19
|
|
30
|
+
|
|
31
|
+
- E01-B: referencia ADE continua finita independiente, Pe2/10, promedios de celda,
|
|
32
|
+
refinamiento y criterios fijados previamente; 16 integraciones, 138 criterios satisfechos.
|
|
33
|
+
- Perfiles gaussianos experimentales de sigma conocida con nuisance reoptimizados,
|
|
34
|
+
multiinicio y presupuesto; objetivo batch K/k compatible con múltiples condiciones.
|
|
35
|
+
- Rechazo de booleanos mezclados con números antes de la coerción de NumPy.
|
|
36
|
+
- Preparación técnica de registro con inventario SHA y campos de derechos pendientes;
|
|
37
|
+
no se realiza registro ni se determina autoría.
|
|
38
|
+
|
|
39
|
+
- Integración del dossier EnvSoft y catálogo separado de las seis fuentes externas.
|
|
40
|
+
- E01-A: protocolo congelado en e60dba9 y ejecución de 40 integraciones, 219 criterios
|
|
41
|
+
satisfechos; evidencia sintética conservada. E01 general sigue parcial.
|
|
42
|
+
- GUI local opcional `python -m pyfast.web`, con batch/columna, configuraciones SI,
|
|
43
|
+
resultados trazables y límites de ejecución; no añade otro solver.
|
|
44
|
+
- Documentación navegable, comprobación de enlaces, control local de calidad con
|
|
45
|
+
hashes/entorno/logs e instrucciones para workers y commits.
|
|
46
|
+
- Diseño E02-A propuesto; E04 continúa bloqueado por metadatos. Sin publicación
|
|
47
|
+
en GitHub, cambios de licencia ni redistribución de FAST/datasets externos.
|
|
48
|
+
|
|
49
|
+
## 0.2.0.dev0 — prototipo científico, 2026-11-18
|
|
50
|
+
|
|
51
|
+
- Motor independiente batch LDF y columna LDF/HSDM, sin invocar FAST.
|
|
52
|
+
- Isotermas con derivadas, mezclas genéricas, matrices FV dispersas y controles de masa/estado.
|
|
53
|
+
- Ajuste inicial, diagnóstico local SVD, Monte Carlo, sensibilidad y NSGA-II opcional.
|
|
54
|
+
- Hidráulica, costos parciales explícitos y envolvente DXF verificada por lector independiente.
|
|
55
|
+
- CSV experimental con unidades y hash; JSON/CSV/Parquet de resultados y CLI.
|
|
56
|
+
- Ejemplos sintéticos integrados y diseño robusto preliminar con malla de comprobación.
|
|
57
|
+
- Referencias analíticas/matriciales, refinamiento y regresión para cancelación en película casi nula.
|
|
58
|
+
- Propuesta Open Core Apache-2.0, con titularidad y publicación aún pendientes.
|
|
59
|
+
|
|
60
|
+
No establece validación experimental, identificabilidad global, frente robusto convergido,
|
|
61
|
+
diseño mecánico, STEP ni interfaz web.
|
|
62
|
+
|
|
63
|
+
## 0.1.0.dev0 — fundación, 2026-11-18
|
|
64
|
+
|
|
65
|
+
Auditoría de solo lectura FAST, cinco documentos técnicos, unidades SI, esquemas
|
|
66
|
+
tipados, trazabilidad y empaquetado. El ZIP original permanece sin cambios.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "Si usa SorbFlow en un trabajo publicado, cítelo con estos metadatos."
|
|
3
|
+
title: "SorbFlow: modelación configurable de adsorción en fase acuosa"
|
|
4
|
+
type: software
|
|
5
|
+
version: 0.3.0
|
|
6
|
+
date-released: 2026-11-21
|
|
7
|
+
license: Apache-2.0
|
|
8
|
+
repository-code: "https://github.com/karelsanchez/SorbFlow"
|
|
9
|
+
url: "https://sorbflow.readthedocs.io"
|
|
10
|
+
keywords:
|
|
11
|
+
- adsorption
|
|
12
|
+
- water treatment
|
|
13
|
+
- fixed-bed column
|
|
14
|
+
- breakthrough curve
|
|
15
|
+
- LDF
|
|
16
|
+
- HSDM
|
|
17
|
+
- Python
|
|
18
|
+
authors:
|
|
19
|
+
- family-names: "Sanchez Hernandez"
|
|
20
|
+
given-names: "Karel Aldrin"
|
|
21
|
+
affiliation: "Universidad de Cundinamarca"
|
|
22
|
+
- family-names: "Rodriguez Saiz"
|
|
23
|
+
given-names: "David Esteban"
|
|
24
|
+
- family-names: "Cabrera Obando"
|
|
25
|
+
given-names: "Dayana Ximena"
|
|
26
|
+
- family-names: "Romo Cadena"
|
|
27
|
+
given-names: "Gabriela Johana"
|
|
28
|
+
abstract: >-
|
|
29
|
+
SorbFlow es una herramienta en Python para modelar, simular, calibrar y diseñar
|
|
30
|
+
procesos de adsorción en fase acuosa en reactores batch y columnas de lecho fijo,
|
|
31
|
+
con isotermas lineal, Langmuir y Freundlich, cinética LDF y difusión superficial
|
|
32
|
+
homogénea (HSDM), calibración, incertidumbre, optimización multiobjetivo y
|
|
33
|
+
resultados trazables.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Autores y colaboradores
|
|
2
|
+
|
|
3
|
+
| Orden | Persona | Rol |
|
|
4
|
+
|---|---|---|
|
|
5
|
+
| 1 | Karel Aldrin Sanchez Hernandez (K. A. Sanchez Hernandez) | Autor principal y responsable del proyecto: concepción, diseño, desarrollo del software y documentación. Docente de Ingeniería Ambiental, Universidad de Cundinamarca, Facatativá |
|
|
6
|
+
| 2 | David Esteban Rodriguez Saiz | Estudiante de Ingeniería Ambiental; pruebas del software |
|
|
7
|
+
| 3 | Dayana Ximena Cabrera Obando | Estudiante de Ingeniería Ambiental; pruebas del software |
|
|
8
|
+
| 4 | Gabriela Johana Romo Cadena | Validación técnica de los fenómenos químicos |
|
|
9
|
+
|
|
10
|
+
Información declarada por el responsable del proyecto (20 y 21 de noviembre de 2026).
|
|
11
|
+
El proyecto no contó con financiación. La titularidad de los derechos patrimoniales
|
|
12
|
+
corresponde, según la misma declaración, a Karel Aldrin Sanchez Hernandez.
|
|
13
|
+
|
|
14
|
+
Para citar el software, ver [CITATION.cff](https://github.com/karelsanchez/SorbFlow/blob/main/CITATION.cff) y la
|
|
15
|
+
[guía de citación](docs/citation.md). Licencia: [Apache-2.0](LICENSE.md).
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# Etapas científicas E2–E3: decisiones previas a implementación
|
|
2
|
+
|
|
3
|
+
Fecha: 2026-11-18. Alcance: isotermas y LDF batch/columna propios. Sin evidencia
|
|
4
|
+
experimental aún; se extiende el alcance a HSDM tras las referencias LDF.
|
|
5
|
+
Inferencia avanzada, NSGA-II y CAD permanecen pendientes.
|
|
6
|
+
|
|
7
|
+
## Dominio genérico y API
|
|
8
|
+
|
|
9
|
+
No se codifican cuatro materiales ni un contaminante fijo. Species y material son
|
|
10
|
+
identidades configurables; una receta admite N componentes y fracciones másicas secas
|
|
11
|
+
que sumen uno. La receta documenta preparación: no se deduce una isoterma de mezcla
|
|
12
|
+
por promedio de parámetros sin datos. El dominio numérico inicial sigue siendo una
|
|
13
|
+
especie acuosa y una temperatura fija por ensayo. Configurar otro contaminante no
|
|
14
|
+
implementa competencia, especiación de metales ni cambios de pH automáticamente.
|
|
15
|
+
|
|
16
|
+
La superficie prevista es `sorbflow.fit`, `sorbflow.simulate`, `sorbflow.optimize`,
|
|
17
|
+
`sorbflow.uncertainty`, `sorbflow.design`, `sorbflow.validate`, API/CLI y web posterior.
|
|
18
|
+
El core científico y diagnósticos serán independientes de la edición comercial.
|
|
19
|
+
Se adopta como propuesta del propietario Apache-2.0 para `sorbflow-core` y repositorio
|
|
20
|
+
separado `sorbflow-design-pro`. Titularidad universitaria y licencia definitiva pendientes:
|
|
21
|
+
no se cambia aún la concesión de derechos ni el nombre provisional de distribución.
|
|
22
|
+
|
|
23
|
+
## E2
|
|
24
|
+
|
|
25
|
+
Isotermas con protocolo extensible y fábrica desde parámetros: Langmuir, Freundlich
|
|
26
|
+
normalizado y lineal (K>=0, incluyendo trazador K=0). La nueva variante `linear` es
|
|
27
|
+
aditiva al esquema v1: archivos anteriores siguen siendo legibles; software anterior
|
|
28
|
+
no interpreta la nueva variante. Funciones vectorizadas SI y derivadas explícitas.
|
|
29
|
+
Freundlich con exponente<1 tiene derivada singular en cero: se informa, no se suaviza.
|
|
30
|
+
|
|
31
|
+
Batch cerrado: dos estados c y q; una misma fuente LDF s=k(q*(c)-q) se usa en
|
|
32
|
+
dc/dt=-(m/V)s y dq/dt=s. Se integra con BDF/Radau y tolerancias físicas separadas.
|
|
33
|
+
Referencia lineal exacta: c_eq=(V c0+m q0)/(V+m K),
|
|
34
|
+
c(t)=c_eq+(c0-c_eq)exp[-k(1+mK/V)t]; q se obtiene del balance total.
|
|
35
|
+
|
|
36
|
+
## E3
|
|
37
|
+
|
|
38
|
+
Columna cilíndrica uniforme, malla axial de N volúmenes finitos. Flujo interno
|
|
39
|
+
J=u*c_upwind-epsilon*Dax*(c_right-c_left)/dz. Fronteras de flujo J_in=u*c_in,
|
|
40
|
+
J_out=u*c_last, que discretizan Danckwerts y salida sin gradiente. Se acopla
|
|
41
|
+
epsilon dc_i/dt=-(J_right-J_left)/dz-rho_b*s_i, dq_i/dt=s_i.
|
|
42
|
+
Inventario por celda A dz(epsilon*c_i+rho_b*q_i); entradas y salidas acumuladas
|
|
43
|
+
como estados: dMin/dt=Q*c_in, dMout/dt=Q*c_last. El balance telescopa exactamente
|
|
44
|
+
en el espacio. El primer esquema upwind tiene difusión numérica de orden uno.
|
|
45
|
+
El valor de salida representa la última celda, no una concentración puntual exacta.
|
|
46
|
+
|
|
47
|
+
Los integradores implícitos pueden evaluar iteraciones de Newton fuera del dominio.
|
|
48
|
+
Solo para esas evaluaciones se extiende q*(c) de forma impar a c<0, sin modificar
|
|
49
|
+
la isoterma para c>=0. No se recortan estados ni resultados. Se comprueban los pasos
|
|
50
|
+
aceptados y las salidas: negatividad por encima de diez tolerancias absolutas,
|
|
51
|
+
estado no finito, fallo del integrador o residuo de masa excesivo generan error.
|
|
52
|
+
Una derivada singular puede causar fallo numérico: se reporta, no se oculta.
|
|
53
|
+
|
|
54
|
+
Jacobiano disperso por diferencias finitas con patrón de dependencias de transporte,
|
|
55
|
+
cinética local y cuadraturas. BDF/Radau de SciPy son integradores externos permisivos;
|
|
56
|
+
las ecuaciones y flujos de SorbFlow son originales y no usan FAST.
|
|
57
|
+
|
|
58
|
+
## Evidencia requerida antes de entregar
|
|
59
|
+
|
|
60
|
+
Isotermas: valores conocidos, límites, derivadas y entradas inválidas. Batch: solución
|
|
61
|
+
lineal exacta, equilibrio, adsorción/desorción, masa y comparación BDF/Radau. Columna:
|
|
62
|
+
trazador frente analítico, solución de cadena de tanques equivalente al FV, equilibrio,
|
|
63
|
+
conservación con dispersión y adsorción/desorción, refinamiento axial/temporal y
|
|
64
|
+
comparación entre integradores. Resultados con unidades, opciones, huella de problema,
|
|
65
|
+
versiones y diagnósticos exportables sin confundirlos con validación experimental.
|
|
66
|
+
|
|
67
|
+
Dependencias nuevas revisadas: [licencia NumPy](https://numpy.org/doc/stable/license.html)
|
|
68
|
+
y [licencia SciPy](https://github.com/scipy/scipy/blob/main/LICENSE.txt), BSD de tres
|
|
69
|
+
cláusulas en sus núcleos. Los wheels pueden incluir bibliotecas adicionales con sus
|
|
70
|
+
avisos. Se instalan como dependencias y no se redistribuyen dentro del código SorbFlow.
|
|
71
|
+
[solve_ivp](https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.solve_ivp.html)
|
|
72
|
+
documenta los integradores y tolerancias usados.
|
|
73
|
+
|
|
74
|
+
## E4 — HSDM antes de codificarlo
|
|
75
|
+
|
|
76
|
+
Radios de caras uniformes, centros de cascarón y volúmenes esféricos exactos
|
|
77
|
+
w_j=(r_right³-r_left³)/3. El término radial es la diferencia de flujos r²Ds*dq/dr
|
|
78
|
+
dividida por w_j. En r=0 el flujo se fija a cero, sin evaluar 1/r². La carga media
|
|
79
|
+
usa pesos w_j/sum(w_j).
|
|
80
|
+
|
|
81
|
+
Película acoplada a la última celda radial: con delta=R-r_last y g=rho_p*Ds/delta,
|
|
82
|
+
resolver k_f*c_s+g*q*(c_s)=k_f*c+g*q_last. El lado izquierdo es monótono para las
|
|
83
|
+
isotermas actuales; se usa bisección vectorizada acotada y se verifica el residuo.
|
|
84
|
+
Para iteraciones implícitas se utiliza la extensión impar documentada, no una
|
|
85
|
+
regularización en c>=0. El flujo compartido j=k_f*(c-c_s) entra en la partícula y
|
|
86
|
+
sale del líquido con área específica 3(1-epsilon)/R. La igualdad de fuentes y
|
|
87
|
+
sumas de cascarones conserva exactamente la masa en la discretización espacial.
|
|
88
|
+
La solución de película tiene tolerancia ligada a precisión de máquina; no se
|
|
89
|
+
selecciona una concentración superficial ad hoc ni se elimina película implícitamente.
|
|
90
|
+
Se permiten hasta 256 bisecciones, con salida al alcanzar residuo relativo de máquina;
|
|
91
|
+
casos extremos que no lo alcancen fallan explícitamente.
|
|
92
|
+
|
|
93
|
+
Se selecciona la expresión de flujo mejor condicionada entre k_f(c-c_s) y
|
|
94
|
+
g(q*(c_s)-q_last), comparando escalas de cancelación absolutas. Esto evita pérdida
|
|
95
|
+
de precisión en película casi nula o difusión casi instantánea. Compartir un flujo
|
|
96
|
+
garantiza conservación, pero por sí solo no prueba que ese flujo sea preciso.
|
|
97
|
+
|
|
98
|
+
Se retienen perfiles radiales en resultados y JSON. Referencias: serie analítica
|
|
99
|
+
de difusión esférica a superficie fija (hasta 80 cascarones), balance columna,
|
|
100
|
+
trazador, comparación BDF/Radau y refinamiento radial. Superficie fija es un
|
|
101
|
+
benchmark del operador radial, separado del problema físico con película finita.
|
|
102
|
+
|
|
103
|
+
## Ajuste inverso inicial
|
|
104
|
+
|
|
105
|
+
`sorbflow.fit.isotherm` ajustará parámetros positivos en coordenadas logarítmicas por
|
|
106
|
+
mínimos cuadrados, con incertidumbres de medición opcionales. En Freundlich se fija
|
|
107
|
+
c_ref: ajustar simultáneamente q_ref y c_ref introduciría redundancia estructural.
|
|
108
|
+
`sorbflow.fit.batch_rate` estimará únicamente k_LDF cuando equilibrio y condiciones se
|
|
109
|
+
dan como conocidos. Usará tolerancias de simulación más estrictas que el cambio
|
|
110
|
+
de parámetros empleado para diferencias finitas.
|
|
111
|
+
|
|
112
|
+
SVD del Jacobiano respecto a log-parámetros, condición, rango y covarianza local son
|
|
113
|
+
diagnósticos iniciales. No sustituyen perfiles de likelihood, incertidumbre en entradas,
|
|
114
|
+
multimodalidad ni validación independiente. El rango deficiente no se oculta con una
|
|
115
|
+
pseudoinversa que parezca un intervalo confiable: la covarianza no se devuelve.
|
|
116
|
+
No se admiten observaciones censuradas en esta API inicial.
|
|
117
|
+
|
|
118
|
+
## UQ, diseño y optimización iniciales
|
|
119
|
+
|
|
120
|
+
Monte Carlo recibirá un muestreador con Generator local y semilla explícita. Conservará
|
|
121
|
+
las muestras reales, salidas, cuantiles y error estándar de la media; un fallo del
|
|
122
|
+
modelo abortará con índice de muestra, sin eliminar silenciosamente casos inviables.
|
|
123
|
+
Sensibilidad central requerirá pasos físicos explícitos para cada parámetro.
|
|
124
|
+
La correlación de entradas corresponde al muestreador; no asumir independencia.
|
|
125
|
+
|
|
126
|
+
Diseño inicial: propiedades hidráulicas, EBCT, masa seca, Ergun y energía de bombeo.
|
|
127
|
+
Los costos usarán precios proporcionados por el llamador, moneda y año base explícitos;
|
|
128
|
+
no se inventarán valores de mercado. DXF contendrá solo envolvente geométrica en metros,
|
|
129
|
+
con metadatos de alcance; STEP y cálculo mecánico serán adaptadores posteriores.
|
|
130
|
+
|
|
131
|
+
NSGA-II será un adaptador opcional a pymoo, cuya licencia Apache-2.0 se revisa antes
|
|
132
|
+
de usarlo. No se copia su implementación. Objetivos de minimización y restricciones
|
|
133
|
+
normalizadas g<=0 serán explícitos; fallos de simulación abortan. Se reevalúan las
|
|
134
|
+
soluciones finales y se rechaza un resultado sin soluciones factibles. Semilla,
|
|
135
|
+
opciones, límites e identificador del problema acompañan el frente. Un frente de
|
|
136
|
+
un algoritmo heurístico no prueba óptimo global ni diseño industrial validado.
|
|
137
|
+
La robustez se construye con muestras de escenarios comunes entre diseños; la
|
|
138
|
+
incertidumbre no se reduce a volver a sortear escenarios en cada evaluación.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
@echo off
|
|
2
|
+
setlocal
|
|
3
|
+
cd /d "%~dp0"
|
|
4
|
+
if not exist ".venv\Scripts\python.exe" (
|
|
5
|
+
echo Falta el entorno Python. Consulte docs\getting_started.md.
|
|
6
|
+
pause
|
|
7
|
+
exit /b 1
|
|
8
|
+
)
|
|
9
|
+
echo SorbFlow local: abra http://127.0.0.1:8765 en Chrome.
|
|
10
|
+
echo Mantenga esta ventana abierta. Ctrl+C cierra el servidor.
|
|
11
|
+
".venv\Scripts\python.exe" -m sorbflow.web --host 127.0.0.1 --port 8765 --output runs/gui
|