watertap/pyproject.toml at main · watertap-org/watertap · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
[build-system]
build-backend = "setuptools.build_meta"
requires = ["setuptools >= 64"]

[project]
name = "watertap"
description = "WaterTAP modeling library"
readme = { file = "README.md", content-type = "text/markdown" }
authors = [{ name = "NAWI team" }]
license = "BSD-3-Clause"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: End Users/Desktop",
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Operating System :: MacOS",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: Unix",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: Implementation :: CPython",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Scientific/Engineering :: Chemistry",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Programming Language :: Python :: 3 :: Only",
]
keywords = [
    "water systems",
    "chemical engineering",
    "process modeling",
    "filtration",
    "desalination",
    "nawi",
]
version = "1.8.0.dev0"

dependencies = [
    # primary requirements for unit and property models
    # allow X.Y.Z stable release(s) and X.Y+1.dev0 (i.e. the main branch after X.Y.Z)
    # disallow X.Y+1.0rc0 (i.e. forcing a manual update to this requirement)
    "idaes-pse>=2.12.0",
    "pyomo>=6.6.1",
    "watertap-solvers",
    "pyyaml",            # watertap.core.wt_database
    # for parameter_sweep
    "parameter-sweep>=0.2.0",
    "numpy",
    "pint<0.25",
]

[project.urls]
Homepage = "https://github.com/watertap-org/watertap"


[project.optional-dependencies]
testing = [
    "pytest==9.0.3",
    "pandas",
    # treebeardtech/nbmake#121
    "nbmake!=1.5.1",
    "nbconvert",
    "idaes-flowsheet-processor>=0.3.2",
]
notebooks = ["jupyter", "ipykernel"]
oli_api = [
    "requests",
    "cryptography", # for encrypting OLI credentials
]

reaktoro = [
    "reaktoro-pse>=0.4.1",
]

exposan = [
    "exposan",
]

dev = [
    "black==26.3.1",
    "pre-commit",

    # coverage
    "pytest-cov",

    # pylint and astroid should be pinned to exact versions
    "pylint==3.3.9",
    "astroid==3.3.11",

    # docs
    "sphinx==7.1.*",
    "nbsphinx",
    "sphinx_rtd_theme",

    # include all optional dependencies
    "watertap[testing,notebooks,oli_api,reaktoro]",
]

all = ["watertap[testing,notebooks,oli_api,reaktoro,exposan]"]

[tool.setuptools]
zip-safe = false
include-package-data = true

[tool.setuptools.packages.find]
include = ["watertap*"]


[tool.pylint.main]
py-version = "3.10"

[tool.setuptools.package-data]
"*" = ["*.json", "*.yaml", "*.yml", "*.csv", "*.png"]

"watertap.tools.oli_api.tests" = ["test.dbs"]

[project.entry-points."watertap.flowsheets"]
nf = "watertap.flowsheets.nf_dspmde.nf_ui"
bsm2 = "watertap.flowsheets.full_water_resource_recovery_facility.BSM2_ui"
bsm2_P_extension = "watertap.flowsheets.full_water_resource_recovery_facility.BSM2_P_extension_ui"
dye_desalination = "watertap.flowsheets.dye_desalination.dye_desalination_ui"
mvc = "watertap.flowsheets.mvc.mvc_single_stage_ui"
RO = "watertap.flowsheets.RO_with_energy_recovery.RO_with_energy_recovery_ui"
OARO = "watertap.flowsheets.oaro.oaro_multi_ui"
GAC = "watertap.flowsheets.gac.gac_ui"
ED_conc_recirc = "watertap.flowsheets.electrodialysis.electrodialysis_1stack_conc_recirc_ui"
LSRRO = "watertap.flowsheets.lsrro.lsrro_ui"
"generic desal train" = "watertap.flowsheets.generic_desalination_train.generic_train_ui"
SWRO = "watertap.flowsheets.seawater_RO_desalination.seawater_RO_desalination_ui"


[tool.pylint."messages control"]
disable = [
    "W",                            # all warnings
    "C",                            # all conventions
    "R",                            # all refactor
    "invalid-unary-operand-type",   # Pyomo -(Var) or -(Expression)
    "unsupported-binary-operation", # Pyomo Set union |
    "no-member",                    # Pyomo / IDAES metaprogramming, a few other places
    "no-name-in-module",            # IDAES metaprogramming
    "undefined-variable",           # IDAES metaprogramming, a few other places
]
# see https://pylint.readthedocs.io/en/latest/user_guide/messages/messages_overview.html
# for a list of all messages
enable = ["unnecessary-pass", "unused-import"]