pathsim-chem 0.0.2__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.
- pathsim_chem-0.0.2/.github/workflows/pypi_deployment.yml +33 -0
- pathsim_chem-0.0.2/.gitignore +212 -0
- pathsim_chem-0.0.2/LICENSE +21 -0
- pathsim_chem-0.0.2/PKG-INFO +42 -0
- pathsim_chem-0.0.2/README.md +4 -0
- pathsim_chem-0.0.2/docs/.readthedocs.yaml +18 -0
- pathsim_chem-0.0.2/docs/Makefile +20 -0
- pathsim_chem-0.0.2/docs/make.bat +35 -0
- pathsim_chem-0.0.2/docs/requirements.txt +7 -0
- pathsim_chem-0.0.2/docs/source/_static/custom.css +64 -0
- pathsim_chem-0.0.2/docs/source/api.rst +12 -0
- pathsim_chem-0.0.2/docs/source/conf.py +103 -0
- pathsim_chem-0.0.2/docs/source/index.rst +34 -0
- pathsim_chem-0.0.2/docs/source/logos/pathsim_logo.png +0 -0
- pathsim_chem-0.0.2/docs/source/logos/pathsim_logo_mono_g.png +0 -0
- pathsim_chem-0.0.2/docs/source/logos/pathsim_logo_mono_k.png +0 -0
- pathsim_chem-0.0.2/docs/source/logos/pathsim_logo_mono_lg.png +0 -0
- pathsim_chem-0.0.2/pyproject.toml +60 -0
- pathsim_chem-0.0.2/setup.cfg +4 -0
- pathsim_chem-0.0.2/src/pathsim_chem/__init__.py +13 -0
- pathsim_chem-0.0.2/src/pathsim_chem/_version.py +34 -0
- pathsim_chem-0.0.2/src/pathsim_chem.egg-info/PKG-INFO +42 -0
- pathsim_chem-0.0.2/src/pathsim_chem.egg-info/SOURCES.txt +24 -0
- pathsim_chem-0.0.2/src/pathsim_chem.egg-info/dependency_links.txt +1 -0
- pathsim_chem-0.0.2/src/pathsim_chem.egg-info/requires.txt +14 -0
- pathsim_chem-0.0.2/src/pathsim_chem.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
on:
|
|
3
|
+
release:
|
|
4
|
+
types: [published]
|
|
5
|
+
workflow_dispatch:
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
id-token: write
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
deploy:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
18
|
+
|
|
19
|
+
- name: Set up Python
|
|
20
|
+
uses: actions/setup-python@v3
|
|
21
|
+
with:
|
|
22
|
+
python-version: '3.x'
|
|
23
|
+
|
|
24
|
+
- name: Install dependencies
|
|
25
|
+
run: |
|
|
26
|
+
python -m pip install --upgrade pip
|
|
27
|
+
pip install build wheel setuptools
|
|
28
|
+
|
|
29
|
+
- name: Build package
|
|
30
|
+
run: python -m build
|
|
31
|
+
|
|
32
|
+
- name: Publish package
|
|
33
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
docs/build/
|
|
74
|
+
docs/source/_autosummary/
|
|
75
|
+
|
|
76
|
+
# PyBuilder
|
|
77
|
+
.pybuilder/
|
|
78
|
+
target/
|
|
79
|
+
|
|
80
|
+
# Jupyter Notebook
|
|
81
|
+
.ipynb_checkpoints
|
|
82
|
+
|
|
83
|
+
# IPython
|
|
84
|
+
profile_default/
|
|
85
|
+
ipython_config.py
|
|
86
|
+
|
|
87
|
+
# pyenv
|
|
88
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
89
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
90
|
+
# .python-version
|
|
91
|
+
|
|
92
|
+
# pipenv
|
|
93
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
94
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
95
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
96
|
+
# install all needed dependencies.
|
|
97
|
+
#Pipfile.lock
|
|
98
|
+
|
|
99
|
+
# UV
|
|
100
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
101
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
102
|
+
# commonly ignored for libraries.
|
|
103
|
+
#uv.lock
|
|
104
|
+
|
|
105
|
+
# poetry
|
|
106
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
107
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
108
|
+
# commonly ignored for libraries.
|
|
109
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
110
|
+
#poetry.lock
|
|
111
|
+
#poetry.toml
|
|
112
|
+
|
|
113
|
+
# pdm
|
|
114
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
115
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
116
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
117
|
+
#pdm.lock
|
|
118
|
+
#pdm.toml
|
|
119
|
+
.pdm-python
|
|
120
|
+
.pdm-build/
|
|
121
|
+
|
|
122
|
+
# pixi
|
|
123
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
124
|
+
#pixi.lock
|
|
125
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
126
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
127
|
+
.pixi
|
|
128
|
+
|
|
129
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
130
|
+
__pypackages__/
|
|
131
|
+
|
|
132
|
+
# Celery stuff
|
|
133
|
+
celerybeat-schedule
|
|
134
|
+
celerybeat.pid
|
|
135
|
+
|
|
136
|
+
# SageMath parsed files
|
|
137
|
+
*.sage.py
|
|
138
|
+
|
|
139
|
+
# Environments
|
|
140
|
+
.env
|
|
141
|
+
.envrc
|
|
142
|
+
.venv
|
|
143
|
+
env/
|
|
144
|
+
venv/
|
|
145
|
+
ENV/
|
|
146
|
+
env.bak/
|
|
147
|
+
venv.bak/
|
|
148
|
+
|
|
149
|
+
# Spyder project settings
|
|
150
|
+
.spyderproject
|
|
151
|
+
.spyproject
|
|
152
|
+
|
|
153
|
+
# Rope project settings
|
|
154
|
+
.ropeproject
|
|
155
|
+
|
|
156
|
+
# mkdocs documentation
|
|
157
|
+
/site
|
|
158
|
+
|
|
159
|
+
# mypy
|
|
160
|
+
.mypy_cache/
|
|
161
|
+
.dmypy.json
|
|
162
|
+
dmypy.json
|
|
163
|
+
|
|
164
|
+
# Pyre type checker
|
|
165
|
+
.pyre/
|
|
166
|
+
|
|
167
|
+
# pytype static type analyzer
|
|
168
|
+
.pytype/
|
|
169
|
+
|
|
170
|
+
# Cython debug symbols
|
|
171
|
+
cython_debug/
|
|
172
|
+
|
|
173
|
+
# PyCharm
|
|
174
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
175
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
176
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
177
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
178
|
+
#.idea/
|
|
179
|
+
|
|
180
|
+
# Abstra
|
|
181
|
+
# Abstra is an AI-powered process automation framework.
|
|
182
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
183
|
+
# Learn more at https://abstra.io/docs
|
|
184
|
+
.abstra/
|
|
185
|
+
|
|
186
|
+
# Visual Studio Code
|
|
187
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
188
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
189
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
190
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
191
|
+
# .vscode/
|
|
192
|
+
|
|
193
|
+
# Ruff stuff:
|
|
194
|
+
.ruff_cache/
|
|
195
|
+
|
|
196
|
+
# PyPI configuration file
|
|
197
|
+
.pypirc
|
|
198
|
+
|
|
199
|
+
# Cursor
|
|
200
|
+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
201
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
202
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
203
|
+
.cursorignore
|
|
204
|
+
.cursorindexingignore
|
|
205
|
+
|
|
206
|
+
# Marimo
|
|
207
|
+
marimo/_static/
|
|
208
|
+
marimo/_lsp/
|
|
209
|
+
__marimo__/
|
|
210
|
+
|
|
211
|
+
# Version file (generated by setuptools-scm)
|
|
212
|
+
src/pathsim_chem/_version.py
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 PathSim
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pathsim-chem
|
|
3
|
+
Version: 0.0.2
|
|
4
|
+
Summary: Chemical Engineering Blocks for PathSim
|
|
5
|
+
Author: PathSim Contributors
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/pathsim/pathsim-chem
|
|
8
|
+
Project-URL: Documentation, https://pathsim-chem.readthedocs.io
|
|
9
|
+
Project-URL: Repository, https://github.com/pathsim/pathsim-chem
|
|
10
|
+
Project-URL: Issues, https://github.com/pathsim/pathsim-chem/issues
|
|
11
|
+
Keywords: simulation,chemical engineering,process modeling
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering
|
|
22
|
+
Requires-Python: >=3.9
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
License-File: LICENSE
|
|
25
|
+
Requires-Dist: pathsim
|
|
26
|
+
Requires-Dist: numpy<2,>=1.15
|
|
27
|
+
Requires-Dist: scipy>=1.2
|
|
28
|
+
Provides-Extra: test
|
|
29
|
+
Requires-Dist: pytest>=7.0; extra == "test"
|
|
30
|
+
Requires-Dist: pytest-cov>=4.0; extra == "test"
|
|
31
|
+
Provides-Extra: docs
|
|
32
|
+
Requires-Dist: sphinx>=7.0; extra == "docs"
|
|
33
|
+
Requires-Dist: furo; extra == "docs"
|
|
34
|
+
Requires-Dist: myst-parser; extra == "docs"
|
|
35
|
+
Requires-Dist: sphinx-copybutton; extra == "docs"
|
|
36
|
+
Requires-Dist: sphinx-design; extra == "docs"
|
|
37
|
+
Dynamic: license-file
|
|
38
|
+
|
|
39
|
+
# PathSim-Chem
|
|
40
|
+
|
|
41
|
+
Chemical Engineering Blocks for PathSim.
|
|
42
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Read the Docs configuration file
|
|
2
|
+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
3
|
+
|
|
4
|
+
version: 2
|
|
5
|
+
|
|
6
|
+
build:
|
|
7
|
+
os: ubuntu-24.04
|
|
8
|
+
tools:
|
|
9
|
+
python: "3.13"
|
|
10
|
+
|
|
11
|
+
sphinx:
|
|
12
|
+
configuration: docs/source/conf.py
|
|
13
|
+
|
|
14
|
+
python:
|
|
15
|
+
install:
|
|
16
|
+
- method: pip
|
|
17
|
+
path: .
|
|
18
|
+
- requirements: docs/requirements.txt
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Minimal makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line, and also
|
|
5
|
+
# from the environment for the first two.
|
|
6
|
+
SPHINXOPTS ?=
|
|
7
|
+
SPHINXBUILD ?= sphinx-build
|
|
8
|
+
SOURCEDIR = source
|
|
9
|
+
BUILDDIR = build
|
|
10
|
+
|
|
11
|
+
# Put it first so that "make" without argument is like "make help".
|
|
12
|
+
help:
|
|
13
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
+
|
|
15
|
+
.PHONY: help Makefile
|
|
16
|
+
|
|
17
|
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
+
%: Makefile
|
|
20
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
@ECHO OFF
|
|
2
|
+
|
|
3
|
+
pushd %~dp0
|
|
4
|
+
|
|
5
|
+
REM Command file for Sphinx documentation
|
|
6
|
+
|
|
7
|
+
if "%SPHINXBUILD%" == "" (
|
|
8
|
+
set SPHINXBUILD=sphinx-build
|
|
9
|
+
)
|
|
10
|
+
set SOURCEDIR=source
|
|
11
|
+
set BUILDDIR=build
|
|
12
|
+
|
|
13
|
+
%SPHINXBUILD% >NUL 2>NUL
|
|
14
|
+
if errorlevel 9009 (
|
|
15
|
+
echo.
|
|
16
|
+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
17
|
+
echo.installed, then set the SPHINXBUILD environment variable to point
|
|
18
|
+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
19
|
+
echo.may add the Sphinx directory to PATH.
|
|
20
|
+
echo.
|
|
21
|
+
echo.If you don't have Sphinx installed, grab it from
|
|
22
|
+
echo.https://www.sphinx-doc.org/
|
|
23
|
+
exit /b 1
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
if "%1" == "" goto help
|
|
27
|
+
|
|
28
|
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
29
|
+
goto end
|
|
30
|
+
|
|
31
|
+
:help
|
|
32
|
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
33
|
+
|
|
34
|
+
:end
|
|
35
|
+
popd
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/* Custom CSS for PathSim-Chem Documentation */
|
|
2
|
+
|
|
3
|
+
/* Fix link preview card backgrounds for light/dark mode */
|
|
4
|
+
.sd-card {
|
|
5
|
+
background-color: var(--color-card-background) !important;
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
.sd-card-header {
|
|
9
|
+
background-color: var(--color-card-marginals-background) !important;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
.sd-card-footer {
|
|
13
|
+
background-color: var(--color-card-marginals-background) !important;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/* Ensure link preview text is readable in both modes */
|
|
17
|
+
.sd-card-text {
|
|
18
|
+
color: var(--color-foreground-primary) !important;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
.sd-card-title {
|
|
22
|
+
color: var(--color-foreground-primary) !important;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/* Fix any link cards created by MyST linkify */
|
|
26
|
+
a.reference.external .sd-card {
|
|
27
|
+
background-color: var(--color-card-background) !important;
|
|
28
|
+
border-color: var(--color-card-border) !important;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/* Main tooltip container */
|
|
32
|
+
.tooltip {
|
|
33
|
+
background-color: var(--color-background-primary) !important;
|
|
34
|
+
border: 1px solid var(--color-background-border) !important;
|
|
35
|
+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15) !important;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/* Dark mode specific adjustments */
|
|
39
|
+
body[data-theme="dark"] .tooltip {
|
|
40
|
+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.5) !important;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/* Tooltip content text */
|
|
44
|
+
.tooltip .highlight,
|
|
45
|
+
.tooltip pre,
|
|
46
|
+
.tooltip code {
|
|
47
|
+
background-color: var(--color-code-background) !important;
|
|
48
|
+
color: var(--color-code-foreground) !important;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/* Tooltip general text */
|
|
52
|
+
.tooltip,
|
|
53
|
+
.tooltip * {
|
|
54
|
+
color: var(--color-foreground-primary) !important;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/* Tooltip links */
|
|
58
|
+
.tooltip a {
|
|
59
|
+
color: var(--color-link) !important;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
.tooltip a:hover {
|
|
63
|
+
color: var(--color-link--hover) !important;
|
|
64
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
API Reference
|
|
2
|
+
=============
|
|
3
|
+
|
|
4
|
+
This page provides the API reference for PathSim-Chem modules and functions.
|
|
5
|
+
|
|
6
|
+
For the core PathSim API, see the `PathSim API Reference <https://pathsim.readthedocs.io/en/latest/api.html>`_.
|
|
7
|
+
|
|
8
|
+
.. autosummary::
|
|
9
|
+
:toctree: _autosummary
|
|
10
|
+
:recursive:
|
|
11
|
+
|
|
12
|
+
pathsim_chem
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Configuration file for the Sphinx documentation builder.
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
import sys
|
|
7
|
+
|
|
8
|
+
# Add the package to the path
|
|
9
|
+
sys.path.insert(0, os.path.abspath('../../src'))
|
|
10
|
+
|
|
11
|
+
# Import version
|
|
12
|
+
try:
|
|
13
|
+
from pathsim_chem import __version__
|
|
14
|
+
except ImportError:
|
|
15
|
+
__version__ = "unknown"
|
|
16
|
+
|
|
17
|
+
# -- Project information -----------------------------------------------------
|
|
18
|
+
|
|
19
|
+
project = 'pathsim-chem'
|
|
20
|
+
copyright = '2025, PathSim Contributors'
|
|
21
|
+
author = 'PathSim Contributors'
|
|
22
|
+
version = __version__
|
|
23
|
+
release = __version__
|
|
24
|
+
|
|
25
|
+
# -- General configuration ---------------------------------------------------
|
|
26
|
+
|
|
27
|
+
extensions = [
|
|
28
|
+
'sphinx.ext.autodoc',
|
|
29
|
+
'sphinx.ext.napoleon',
|
|
30
|
+
'sphinx.ext.viewcode',
|
|
31
|
+
'sphinx.ext.mathjax',
|
|
32
|
+
'sphinx.ext.autosummary',
|
|
33
|
+
'sphinx.ext.intersphinx',
|
|
34
|
+
'myst_parser',
|
|
35
|
+
'sphinx_copybutton',
|
|
36
|
+
'sphinx_design',
|
|
37
|
+
]
|
|
38
|
+
|
|
39
|
+
templates_path = ['_templates']
|
|
40
|
+
exclude_patterns = []
|
|
41
|
+
|
|
42
|
+
# -- Options for HTML output -------------------------------------------------
|
|
43
|
+
|
|
44
|
+
html_theme = 'furo'
|
|
45
|
+
html_static_path = ['_static', 'logos']
|
|
46
|
+
html_css_files = ['custom.css']
|
|
47
|
+
html_logo = 'logos/pathsim_logo.png'
|
|
48
|
+
html_title = "PathSim-Chem Documentation"
|
|
49
|
+
|
|
50
|
+
html_theme_options = {
|
|
51
|
+
"light_css_variables": {
|
|
52
|
+
"color-brand-primary": "#377eb8",
|
|
53
|
+
"color-brand-content": "#377eb8",
|
|
54
|
+
"color-api-keyword": "#377eb8",
|
|
55
|
+
"color-highlight-on-target": "#fff3cd",
|
|
56
|
+
},
|
|
57
|
+
"dark_css_variables": {
|
|
58
|
+
"color-brand-primary": "#377eb8",
|
|
59
|
+
"color-brand-content": "#377eb8",
|
|
60
|
+
"color-api-keyword": "#377eb8",
|
|
61
|
+
"color-highlight-on-target": "#fff3cd",
|
|
62
|
+
},
|
|
63
|
+
"sidebar_hide_name": True,
|
|
64
|
+
"navigation_with_keys": True,
|
|
65
|
+
"top_of_page_button": "edit",
|
|
66
|
+
"source_repository": "https://github.com/pathsim/pathsim-chem",
|
|
67
|
+
"source_branch": "main",
|
|
68
|
+
"source_directory": "docs/source/",
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
# -- Extension configuration -------------------------------------------------
|
|
72
|
+
|
|
73
|
+
# Autodoc settings
|
|
74
|
+
autodoc_default_options = {
|
|
75
|
+
'members': True,
|
|
76
|
+
'member-order': 'bysource',
|
|
77
|
+
'special-members': '__init__',
|
|
78
|
+
'undoc-members': True,
|
|
79
|
+
'exclude-members': '__weakref__'
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
# Napoleon settings
|
|
83
|
+
napoleon_google_docstring = True
|
|
84
|
+
napoleon_numpy_docstring = True
|
|
85
|
+
napoleon_include_init_with_doc = True
|
|
86
|
+
|
|
87
|
+
# Autosummary settings
|
|
88
|
+
autosummary_generate = True
|
|
89
|
+
|
|
90
|
+
# Intersphinx mapping to link to core pathsim documentation
|
|
91
|
+
intersphinx_mapping = {
|
|
92
|
+
'python': ('https://docs.python.org/3', None),
|
|
93
|
+
'numpy': ('https://numpy.org/doc/stable/', None),
|
|
94
|
+
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
|
|
95
|
+
'matplotlib': ('https://matplotlib.org/stable/', None),
|
|
96
|
+
'pathsim': ('https://pathsim.readthedocs.io/en/latest/', None),
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
# MyST settings
|
|
100
|
+
myst_enable_extensions = [
|
|
101
|
+
"colon_fence",
|
|
102
|
+
"deflist",
|
|
103
|
+
]
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
PathSim-Chem
|
|
2
|
+
============
|
|
3
|
+
|
|
4
|
+
Chemical Engineering Blocks for PathSim.
|
|
5
|
+
|
|
6
|
+
PathSim-Chem provides specialized blocks for chemical engineering simulations,
|
|
7
|
+
extending the core `PathSim <https://pathsim.readthedocs.io>`_ framework with
|
|
8
|
+
domain-specific functionality.
|
|
9
|
+
|
|
10
|
+
.. raw:: html
|
|
11
|
+
|
|
12
|
+
<div style="text-align: center; margin: 2rem 0;">
|
|
13
|
+
<a href="https://pathsim.readthedocs.io" style="display: inline-block; padding: 0.75rem 2rem; background: var(--color-background-secondary); color: var(--color-foreground-primary); text-decoration: none; border-radius: 0.5rem; font-weight: 600; margin: 0.5rem; border: 2px solid var(--color-background-border);">
|
|
14
|
+
PathSim
|
|
15
|
+
</a>
|
|
16
|
+
<a href="https://github.com/pathsim/pathsim-chem" style="display: inline-block; padding: 0.75rem 2rem; background: var(--color-background-secondary); color: var(--color-foreground-primary); text-decoration: none; border-radius: 0.5rem; font-weight: 600; margin: 0.5rem; border: 2px solid var(--color-background-border);">
|
|
17
|
+
View on GitHub
|
|
18
|
+
</a>
|
|
19
|
+
<a href="https://github.com/pathsim/pathsim-chem/issues" style="display: inline-block; padding: 0.75rem 2rem; background: var(--color-background-secondary); color: var(--color-foreground-primary); text-decoration: none; border-radius: 0.5rem; font-weight: 600; margin: 0.5rem; border: 2px solid var(--color-background-border);">
|
|
20
|
+
Issue Tracker
|
|
21
|
+
</a>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
Installation
|
|
25
|
+
------------
|
|
26
|
+
|
|
27
|
+
.. code-block:: bash
|
|
28
|
+
|
|
29
|
+
pip install pathsim-chem
|
|
30
|
+
|
|
31
|
+
.. toctree::
|
|
32
|
+
:hidden:
|
|
33
|
+
|
|
34
|
+
api
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=64", "setuptools-scm>=8"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "pathsim-chem"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Chemical Engineering Blocks for PathSim"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
license = {text = "MIT"}
|
|
12
|
+
authors = [
|
|
13
|
+
{name = "PathSim Contributors"}
|
|
14
|
+
]
|
|
15
|
+
keywords = ["simulation", "chemical engineering", "process modeling"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Intended Audience :: Science/Research",
|
|
19
|
+
"License :: OSI Approved :: MIT License",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.9",
|
|
22
|
+
"Programming Language :: Python :: 3.10",
|
|
23
|
+
"Programming Language :: Python :: 3.11",
|
|
24
|
+
"Programming Language :: Python :: 3.12",
|
|
25
|
+
"Programming Language :: Python :: 3.13",
|
|
26
|
+
"Topic :: Scientific/Engineering",
|
|
27
|
+
]
|
|
28
|
+
dependencies = [
|
|
29
|
+
"pathsim",
|
|
30
|
+
"numpy>=1.15,<2",
|
|
31
|
+
"scipy>=1.2",
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[project.optional-dependencies]
|
|
35
|
+
test = [
|
|
36
|
+
"pytest>=7.0",
|
|
37
|
+
"pytest-cov>=4.0",
|
|
38
|
+
]
|
|
39
|
+
docs = [
|
|
40
|
+
"sphinx>=7.0",
|
|
41
|
+
"furo",
|
|
42
|
+
"myst-parser",
|
|
43
|
+
"sphinx-copybutton",
|
|
44
|
+
"sphinx-design",
|
|
45
|
+
]
|
|
46
|
+
|
|
47
|
+
[project.urls]
|
|
48
|
+
Homepage = "https://github.com/pathsim/pathsim-chem"
|
|
49
|
+
Documentation = "https://pathsim-chem.readthedocs.io"
|
|
50
|
+
Repository = "https://github.com/pathsim/pathsim-chem"
|
|
51
|
+
Issues = "https://github.com/pathsim/pathsim-chem/issues"
|
|
52
|
+
|
|
53
|
+
[tool.setuptools]
|
|
54
|
+
package-dir = {"" = "src"}
|
|
55
|
+
|
|
56
|
+
[tool.setuptools.packages.find]
|
|
57
|
+
where = ["src"]
|
|
58
|
+
|
|
59
|
+
[tool.setuptools_scm]
|
|
60
|
+
write_to = "src/pathsim_chem/_version.py"
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"""
|
|
2
|
+
PathSim-Chem: Chemical Engineering Blocks for PathSim
|
|
3
|
+
|
|
4
|
+
A toolbox providing specialized blocks for chemical engineering simulations
|
|
5
|
+
in the PathSim framework.
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
try:
|
|
9
|
+
from ._version import version as __version__
|
|
10
|
+
except ImportError:
|
|
11
|
+
__version__ = "unknown"
|
|
12
|
+
|
|
13
|
+
__all__ = ["__version__"]
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# file generated by setuptools-scm
|
|
2
|
+
# don't change, don't track in version control
|
|
3
|
+
|
|
4
|
+
__all__ = [
|
|
5
|
+
"__version__",
|
|
6
|
+
"__version_tuple__",
|
|
7
|
+
"version",
|
|
8
|
+
"version_tuple",
|
|
9
|
+
"__commit_id__",
|
|
10
|
+
"commit_id",
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
TYPE_CHECKING = False
|
|
14
|
+
if TYPE_CHECKING:
|
|
15
|
+
from typing import Tuple
|
|
16
|
+
from typing import Union
|
|
17
|
+
|
|
18
|
+
VERSION_TUPLE = Tuple[Union[int, str], ...]
|
|
19
|
+
COMMIT_ID = Union[str, None]
|
|
20
|
+
else:
|
|
21
|
+
VERSION_TUPLE = object
|
|
22
|
+
COMMIT_ID = object
|
|
23
|
+
|
|
24
|
+
version: str
|
|
25
|
+
__version__: str
|
|
26
|
+
__version_tuple__: VERSION_TUPLE
|
|
27
|
+
version_tuple: VERSION_TUPLE
|
|
28
|
+
commit_id: COMMIT_ID
|
|
29
|
+
__commit_id__: COMMIT_ID
|
|
30
|
+
|
|
31
|
+
__version__ = version = '0.0.2'
|
|
32
|
+
__version_tuple__ = version_tuple = (0, 0, 2)
|
|
33
|
+
|
|
34
|
+
__commit_id__ = commit_id = 'gd08aa02a1'
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pathsim-chem
|
|
3
|
+
Version: 0.0.2
|
|
4
|
+
Summary: Chemical Engineering Blocks for PathSim
|
|
5
|
+
Author: PathSim Contributors
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/pathsim/pathsim-chem
|
|
8
|
+
Project-URL: Documentation, https://pathsim-chem.readthedocs.io
|
|
9
|
+
Project-URL: Repository, https://github.com/pathsim/pathsim-chem
|
|
10
|
+
Project-URL: Issues, https://github.com/pathsim/pathsim-chem/issues
|
|
11
|
+
Keywords: simulation,chemical engineering,process modeling
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering
|
|
22
|
+
Requires-Python: >=3.9
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
License-File: LICENSE
|
|
25
|
+
Requires-Dist: pathsim
|
|
26
|
+
Requires-Dist: numpy<2,>=1.15
|
|
27
|
+
Requires-Dist: scipy>=1.2
|
|
28
|
+
Provides-Extra: test
|
|
29
|
+
Requires-Dist: pytest>=7.0; extra == "test"
|
|
30
|
+
Requires-Dist: pytest-cov>=4.0; extra == "test"
|
|
31
|
+
Provides-Extra: docs
|
|
32
|
+
Requires-Dist: sphinx>=7.0; extra == "docs"
|
|
33
|
+
Requires-Dist: furo; extra == "docs"
|
|
34
|
+
Requires-Dist: myst-parser; extra == "docs"
|
|
35
|
+
Requires-Dist: sphinx-copybutton; extra == "docs"
|
|
36
|
+
Requires-Dist: sphinx-design; extra == "docs"
|
|
37
|
+
Dynamic: license-file
|
|
38
|
+
|
|
39
|
+
# PathSim-Chem
|
|
40
|
+
|
|
41
|
+
Chemical Engineering Blocks for PathSim.
|
|
42
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
LICENSE
|
|
3
|
+
README.md
|
|
4
|
+
pyproject.toml
|
|
5
|
+
.github/workflows/pypi_deployment.yml
|
|
6
|
+
docs/.readthedocs.yaml
|
|
7
|
+
docs/Makefile
|
|
8
|
+
docs/make.bat
|
|
9
|
+
docs/requirements.txt
|
|
10
|
+
docs/source/api.rst
|
|
11
|
+
docs/source/conf.py
|
|
12
|
+
docs/source/index.rst
|
|
13
|
+
docs/source/_static/custom.css
|
|
14
|
+
docs/source/logos/pathsim_logo.png
|
|
15
|
+
docs/source/logos/pathsim_logo_mono_g.png
|
|
16
|
+
docs/source/logos/pathsim_logo_mono_k.png
|
|
17
|
+
docs/source/logos/pathsim_logo_mono_lg.png
|
|
18
|
+
src/pathsim_chem/__init__.py
|
|
19
|
+
src/pathsim_chem/_version.py
|
|
20
|
+
src/pathsim_chem.egg-info/PKG-INFO
|
|
21
|
+
src/pathsim_chem.egg-info/SOURCES.txt
|
|
22
|
+
src/pathsim_chem.egg-info/dependency_links.txt
|
|
23
|
+
src/pathsim_chem.egg-info/requires.txt
|
|
24
|
+
src/pathsim_chem.egg-info/top_level.txt
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pathsim_chem
|