-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
290 lines (279 loc) · 11.9 KB
/
mkdocs.yml
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# Project information
site_name: PolyKin
site_url: https://hugomvale.github.io/polykin/
site_author: Hugo Vale
site_description: >-
An open-source polymerization kinetics library for Python.
# Repository
repo_name: HugoMVale/polykin
repo_url: https://github.com/HugoMVale/polykin
edit_uri: "" #disables edit button
# Copyright
copyright: Copyright © 2022 - 2024 Hugo Vale
# Configuration
theme:
name: material
language: en
features:
- search.highlight
- search.suggest
# - navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.path
# - navigation.expand
- navigation.top
- toc.follow
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
watch:
- src/polykin
- docs/tutorials
- docs/reference
# Plugins
plugins:
- search
- autolinks
- autorefs
- markdown-exec
- table-reader
#- bibtex:
# bib_file: "docs/bibliography/bibliography.bib"
# csl_file: "docs/bibliography/american-chemical-society.csl"
# - gen-files:
# scripts:
# - docs/reference/gen_reference.py
# - literate-nav:
# nav_file: SUMMARY.txt
# - section-index
# - gallery:
# examples_dirs: docs/tutorials
# gallery_dirs: docs/generated/gallery
- mkdocstrings:
handlers:
python:
paths: [src]
# import:
# - https://docs.python.org/3/objects.inv
options:
modernize_annotations: true
docstring_section_style: spacy
group_by_category: false
# show_category_heading: true
show_source: true
members_order: alphabetical
docstring_style: numpy
show_root_toc_entry: false
show_bases: false
separate_signature: true
show_signature_annotations: true
inherited_members: true
merge_init_into_class: false
show_symbol_type_toc: true
show_category_heading: false
extensions:
- griffe_inherited_docstrings
- mkdocs-jupyter:
include: ["*.ipynb"]
include_source: false
ignore_h1_titles: true
# Extensions
markdown_extensions:
- admonition
- attr_list
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight
- pymdownx.magiclink
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets:
base_path:
- docs
check_paths: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.arithmatex:
generic: true
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: "¤"
# MathJax
# extra_javascript:
# - javascripts/mathjax.js
# - https://polyfill.io/v3/polyfill.min.js?features=es6
# - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# KaTeX
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- css/mkdocstrings.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
# Customization
extra:
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
social:
- icon: fontawesome/brands/github
link: https://github.com/HugoMVale
- icon: fontawesome/brands/python
link: https://pypi.org/project/polykin/
- icon: fontawesome/brands/linkedin
link: https://de.linkedin.com/in/hugo-vale-8b65948a
nav:
- Home:
- index.md
- Installation: installation.md
# - generated/gallery
- Tutorials:
- "tutorials/index.md"
- Activity Coeff. Models: "tutorials/activity_coefficient_models.ipynb"
- Copolymerization: "tutorials/copolymerization.ipynb"
- Copolymerization Fit: "tutorials/copolymerization_fit.ipynb"
- Diffusion Coefficients: "tutorials/diffusion_coefficients.ipynb"
- Distributions: "tutorials/distributions.ipynb"
- Kinetic Coefficients: "tutorials/kinetic_coefficients.ipynb"
- Physical Property Equations: "tutorials/physprop_equations.ipynb"
- Thermal Conductivity: "tutorials/thermal_conductivity.ipynb"
- Viscosity: "tutorials/viscosity.ipynb"
#- API Reference: reference/polykin/ #
- API Reference:
- polykin.copolymerization:
- reference/copolymerization/index.md
# - InstantaneousCopoData: reference/copolymerization/InstantaneousCopoData.md
- CopoFitResult: reference/copolymerization/CopoFitResult.md
- ImplicitPenultimateModel: reference/copolymerization/ImplicitPenultimateModel.md
- PenultimateModel: reference/copolymerization/PenultimateModel.md
- TerminalModel: reference/copolymerization/TerminalModel.md
- convert_Qe_to_r: reference/copolymerization/convert_Qe_to_r.md
- fit_Finemann_Ross: reference/copolymerization/fit_Finemann_Ross.md
- fit_copo_data: reference/copolymerization/fit_copo_data.md
- inst_copolymer_binary: reference/copolymerization/inst_copolymer_binary.md
- inst_copolymer_ternary: reference/copolymerization/inst_copolymer_ternary.md
- inst_copolymer_multi: reference/copolymerization/inst_copolymer_multi.md
- kp_average_binary: reference/copolymerization/kp_average_binary.md
- monomer_drift_binary: reference/copolymerization/monomer_drift_binary.md
- monomer_drift_multi: reference/copolymerization/monomer_drift_multi.md
- radical_fractions_ternary: reference/copolymerization/radical_fractions_ternary.md
- radical_fractions_multi: reference/copolymerization/radical_fractions_multi.md
- sequence_multi: reference/copolymerization/sequence_multi.md
- transitions_multi: reference/copolymerization/transitions_multi.md
- tuples_multi: reference/copolymerization/tuples_multi.md
- polykin.distributions:
- reference/distributions/index.md
- DataDistribution: reference/distributions/DataDistribution.md
- Flory: reference/distributions/Flory.md
- LogNormal: reference/distributions/LogNormal.md
- MixtureDistribution: reference/distributions/MixtureDistribution.md
- Poisson: reference/distributions/Poisson.md
- SchulzZimm: reference/distributions/SchulzZimm.md
- WeibullNycanderGold_pdf: reference/distributions/WeibullNycanderGold_pdf.md
- convolve_moments: reference/distributions/convolve_moments.md
- convolve_moments_self: reference/distributions/convolve_moments_self.md
- plotdists: reference/distributions/plotdists.md
- polykin.emulsion:
- nbar_Li_Brooks: reference/emulsion/nbar_Li_Brooks.md
- nbar_Stockmayer_OToole: reference/emulsion/nbar_Stockmayer_OToole.md
- polykin.kinetics:
- reference/kinetics/index.md
- Arrhenius: reference/kinetics/Arrhenius.md
- Eyring: reference/kinetics/Eyring.md
- PropagationHalfLength: reference/kinetics/PropagationHalfLength.md
- TerminationCompositeModel: reference/kinetics/TerminationCompositeModel.md
- polykin.math:
- confidence_ellipse: reference/math/confidence_ellipse.md
- confidence_region: reference/math/confidence_region.md
- derivative_centered: reference/math/derivative_centered.md
- derivative_complex: reference/math/derivative_complex.md
- hessian2: reference/math/hessian2.md
- ode_rk: reference/math/ode_rk.md
- root_newton: reference/math/root_newton.md
- root_secant: reference/math/root_secant.md
- simplify_polyline: reference/math/simplify_polyline.md
- RootResult: reference/math/RootResult.md
- polykin.properties:
- reference/properties/index.md
- Equations: reference/properties/equations/index.md
- Diffusion:
- reference/properties/diffusion/index.md
- VrentasDudaBinary: reference/properties/diffusion/VrentasDudaBinary.md
- DL_Hayduk_Minhas: reference/properties/diffusion/DL_Hayduk_Minhas.md
- DL_Wilke_Chang: reference/properties/diffusion/DL_Wilke_Chang.md
- DV_Wilke_Lee: reference/properties/diffusion/DV_Wilke_Lee.md
- PVT Polymer:
- reference/properties/pvt_polymer/index.md
- Flory: reference/properties/pvt_polymer/Flory.md
- HartmannHaque: reference/properties/pvt_polymer/HartmannHaque.md
- SanchezLacombe: reference/properties/pvt_polymer/SanchezLacombe.md
- Tait: reference/properties/pvt_polymer/Tait.md
- Thermal Conductivity:
- reference/properties/thermal_conductivity/index.md
- KLMX2_Li: reference/properties/thermal_conductivity/KLMX2_Li.md
- KVMX2_Wassilijewa: reference/properties/thermal_conductivity/KVMX2_Wassilijewa.md
- KVPC_Stiel_Thodos: reference/properties/thermal_conductivity/KVPC_Stiel_Thodos.md
- KVMXPC_Stiel_Thodos: reference/properties/thermal_conductivity/KVMXPC_Stiel_Thodos.md
- Vaporization Enthalpy:
#- reference/properties/vaporization_enthalpy/index.md
- DHVL_Kistiakowsky_Vetere: reference/properties/vaporization_enthalpy/DHVL_Kistiakowsky_Vetere.md
- DHVL_Pitzer: reference/properties/vaporization_enthalpy/DHVL_Pitzer.md
- DHVL_Vetere: reference/properties/vaporization_enthalpy/DHVL_Vetere.md
- DHVL_Watson: reference/properties/vaporization_enthalpy/DHVL_Watson.md
- Viscosity:
- reference/properties/viscosity/index.md
- MULMX2_Perry: reference/properties/viscosity/MULMX2_Perry.md
- MUV_Lucas: reference/properties/viscosity/MUV_Lucas.md
- MUVMX_Lucas: reference/properties/viscosity/MUVMX_Lucas.md
- MUVMX2_Herning_Zipperer: reference/properties/viscosity/MUVMX2_Herning_Zipperer.md
- MUVPC_Jossi: reference/properties/viscosity/MUVPC_Jossi.md
- MUVMXPC_Dean_Stiel: reference/properties/viscosity/MUVMXPC_Dean_Stiel.md
- polykin.thermo:
#- reference/thermo/index.md
- Activity Coeff. Models:
- reference/thermo/acm/index.md
- IdealSolution: reference/thermo/acm/IdealSolution.md
- FloryHuggins: reference/thermo/acm/FloryHuggins.md
- FloryHuggins_activity: reference/thermo/acm/FloryHuggins_activity.md
- FloryHuggins2_activity: reference/thermo/acm/FloryHuggins2_activity.md
- NRTL: reference/thermo/acm/NRTL.md
- NRTL_gamma: reference/thermo/acm/NRTL_gamma.md
- UNIQUAC: reference/thermo/acm/UNIQUAC.md
- UNIQUAC_gamma: reference/thermo/acm/UNIQUAC_gamma.md
- Wilson: reference/thermo/acm/Wilson.md
- Wilson_gamma: reference/thermo/acm/Wilson_gamma.md
- Equations of State:
- IdealGas: reference/thermo/eos/IdealGas.md
- PengRobinson: reference/thermo/eos/PengRobinson.md
- RedlichKwong: reference/thermo/eos/RedlichKwong.md
- Soave: reference/thermo/eos/Soave.md
- Virial: reference/thermo/eos/Virial.md
- polykin.stepgrowth:
- Analytical Solutions: reference/stepgrowth/solutions.md
- polykin.utils:
- Exceptions: reference/utils/exceptions.md
- Types: reference/utils/types.md