surrogates_interface 4.3.3__tar.gz → 4.3.4__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.
- surrogates_interface-4.3.4/.gitattributes +2 -0
- surrogates_interface-4.3.4/.gitignore +16 -0
- surrogates_interface-4.3.4/.gitlab/merge_request_templates/default.md +11 -0
- surrogates_interface-4.3.4/.gitlab-ci.yml +172 -0
- surrogates_interface-4.3.4/CHANGELOG.md +32 -0
- surrogates_interface-4.3.4/PKG-INFO +64 -0
- {surrogates_interface-4.3.3 → surrogates_interface-4.3.4}/README.md +3 -1
- surrogates_interface-4.3.4/docs/Makefile +20 -0
- surrogates_interface-4.3.4/docs/make.bat +35 -0
- surrogates_interface-4.3.4/docs/source/api_reference/domains.rst +7 -0
- surrogates_interface-4.3.4/docs/source/api_reference/index.rst +13 -0
- surrogates_interface-4.3.4/docs/source/api_reference/openmdao.rst +7 -0
- surrogates_interface-4.3.4/docs/source/api_reference/surrogates.rst +7 -0
- surrogates_interface-4.3.4/docs/source/api_reference/transformers.rst +7 -0
- surrogates_interface-4.3.4/docs/source/conf.py +99 -0
- surrogates_interface-4.3.4/docs/source/index.rst +270 -0
- surrogates_interface-4.3.4/docs/source/robots.txt +3 -0
- surrogates_interface-4.3.4/docs/source/search_engines_indexing/googleab1f837c998916a3.html +1 -0
- surrogates_interface-4.3.4/docs/source/user_guide/index.rst +5 -0
- surrogates_interface-4.3.4/pixi.lock +7261 -0
- surrogates_interface-4.3.4/pyproject.toml +130 -0
- {surrogates_interface-4.3.3 → surrogates_interface-4.3.4}/surrogates_interface/transformers.py +31 -10
- surrogates_interface-4.3.4/test/conftest.py +30 -0
- surrogates_interface-4.3.4/test/test_domains.py +44 -0
- surrogates_interface-4.3.4/test/test_init.py +12 -0
- surrogates_interface-4.3.4/test/test_pca_jacobian.py +137 -0
- surrogates_interface-4.3.4/test/test_pytorch.py +364 -0
- surrogates_interface-4.3.4/test/test_smt.py +254 -0
- surrogates_interface-4.3.4/test/test_surrogates.py +22 -0
- surrogates_interface-4.3.4/test/test_tensorflow_and_openmdao.py +1224 -0
- surrogates_interface-4.3.4/test/test_transformers.py +626 -0
- surrogates_interface-4.3.3/PKG-INFO +0 -66
- surrogates_interface-4.3.3/pyproject.toml +0 -87
- {surrogates_interface-4.3.3 → surrogates_interface-4.3.4}/surrogates_interface/__init__.py +0 -0
- {surrogates_interface-4.3.3 → surrogates_interface-4.3.4}/surrogates_interface/domains.py +0 -0
- {surrogates_interface-4.3.3 → surrogates_interface-4.3.4}/surrogates_interface/openmdao.py +0 -0
- {surrogates_interface-4.3.3 → surrogates_interface-4.3.4}/surrogates_interface/surrogates.py +0 -0
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
default:
|
|
2
|
+
image:
|
|
3
|
+
# Default pixi docker image.
|
|
4
|
+
name: ghcr.io/prefix-dev/pixi:latest
|
|
5
|
+
pull_policy: if-not-present
|
|
6
|
+
|
|
7
|
+
stages:
|
|
8
|
+
- test
|
|
9
|
+
- build
|
|
10
|
+
- deploy
|
|
11
|
+
|
|
12
|
+
.install_pixi_windows: &install_pixi_windows
|
|
13
|
+
- powershell -ExecutionPolicy Bypass -c "irm -useb https://pixi.sh/install.ps1 | iex"
|
|
14
|
+
- $env:Path += ';C:\Users\ContainerAdministrator\.pixi\bin'
|
|
15
|
+
|
|
16
|
+
# ===== Check code style =====
|
|
17
|
+
check_code_style:
|
|
18
|
+
stage: test
|
|
19
|
+
# when: manual
|
|
20
|
+
needs: []
|
|
21
|
+
script:
|
|
22
|
+
- pixi install -e lint --locked
|
|
23
|
+
- folders="surrogates_interface test"
|
|
24
|
+
- pixi run -e lint --as-is flake8 --select F $folders
|
|
25
|
+
- pixi run -e lint --as-is isort --check-only $folders
|
|
26
|
+
- pixi run -e lint --as-is black --check --diff $folders
|
|
27
|
+
- pixi run -e lint --as-is codespell --enable-colors surrogates_interface
|
|
28
|
+
interruptible: true
|
|
29
|
+
tags:
|
|
30
|
+
- ubuntu
|
|
31
|
+
|
|
32
|
+
# ===== Scan dependencies for vulnerabilities. =====
|
|
33
|
+
.audit:
|
|
34
|
+
stage: test
|
|
35
|
+
# when: manual
|
|
36
|
+
needs: []
|
|
37
|
+
before_script:
|
|
38
|
+
script:
|
|
39
|
+
- poetry self add poetry-plugin-export
|
|
40
|
+
- poetry install --extras "audit"
|
|
41
|
+
- poetry export --without-hashes > requirements.txt
|
|
42
|
+
- poetry run pip-audit -r requirements.txt
|
|
43
|
+
interruptible: true
|
|
44
|
+
allow_failure: true
|
|
45
|
+
tags:
|
|
46
|
+
- ubuntu
|
|
47
|
+
|
|
48
|
+
# ===== Test package on Ubuntu Linux, and check coverage. =====
|
|
49
|
+
test_ubuntu:
|
|
50
|
+
stage: test
|
|
51
|
+
# when: manual
|
|
52
|
+
needs: []
|
|
53
|
+
script:
|
|
54
|
+
- pixi install -e test-complete --locked
|
|
55
|
+
- pixi run -e test-complete --as-is pytest --cov-report term-missing:skip-covered --cov=surrogates_interface --cov-report xml:coverage.xml --junitxml=test_report_ubuntu.xml test
|
|
56
|
+
coverage: /TOTAL.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/
|
|
57
|
+
interruptible: true
|
|
58
|
+
artifacts:
|
|
59
|
+
when: always # Always get the test report, even if the pipeline fails.
|
|
60
|
+
reports:
|
|
61
|
+
junit: test_report_ubuntu.xml
|
|
62
|
+
coverage_report:
|
|
63
|
+
coverage_format: cobertura
|
|
64
|
+
path: coverage.xml
|
|
65
|
+
expire_in: 8h
|
|
66
|
+
tags:
|
|
67
|
+
- ubuntu
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
# ===== Test package on Windows. =====
|
|
71
|
+
test_windows:
|
|
72
|
+
stage: test
|
|
73
|
+
# when: manual
|
|
74
|
+
needs: []
|
|
75
|
+
image: mcr.microsoft.com/windows:ltsc2019
|
|
76
|
+
before_script:
|
|
77
|
+
- *install_pixi_windows
|
|
78
|
+
script:
|
|
79
|
+
# Allow long file paths, or otherwise installing TensorFlow fails.
|
|
80
|
+
- Set-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem -Name LongPathsEnabled -Value 1
|
|
81
|
+
# Install Microsoft Visual C++ Redistributable, or otherwise importing TensorFlow fails.
|
|
82
|
+
- Invoke-WebRequest -Uri https://aka.ms/vs/17/release/vc_redist.x64.exe -OutFile .\VC_redist.x64.exe
|
|
83
|
+
- .\VC_redist.x64.exe /install /quiet /norestart
|
|
84
|
+
# Install this package and run the tests.
|
|
85
|
+
- pixi install -e test-complete --locked
|
|
86
|
+
- pixi run -e test-complete --as-is pytest --junitxml=test_report_windows.xml test
|
|
87
|
+
interruptible: true
|
|
88
|
+
artifacts:
|
|
89
|
+
when: always # Always get the test report, even if the pipeline fails.
|
|
90
|
+
reports:
|
|
91
|
+
junit: test_report_windows.xml
|
|
92
|
+
expire_in: 8h
|
|
93
|
+
tags:
|
|
94
|
+
- windows
|
|
95
|
+
|
|
96
|
+
# ===== Check comment to code ratio. =====
|
|
97
|
+
comment_to_code_ratio:
|
|
98
|
+
stage: test
|
|
99
|
+
when: manual
|
|
100
|
+
needs: []
|
|
101
|
+
image:
|
|
102
|
+
name: alpine:edge
|
|
103
|
+
pull_policy: if-not-present
|
|
104
|
+
script:
|
|
105
|
+
- apk add cloc
|
|
106
|
+
- cloc --by-percent 'c' surrogates_interface
|
|
107
|
+
interruptible: true
|
|
108
|
+
tags:
|
|
109
|
+
- ubuntu
|
|
110
|
+
|
|
111
|
+
# ===== Build and deploy package. =====
|
|
112
|
+
build_and_deploy:
|
|
113
|
+
stage: deploy
|
|
114
|
+
needs:
|
|
115
|
+
- test_ubuntu
|
|
116
|
+
- test_windows
|
|
117
|
+
script:
|
|
118
|
+
- pixi install -e deploy --locked
|
|
119
|
+
- pixi run -e deploy --as-is python -m build
|
|
120
|
+
# Upload to Gitlab package registry and then to PyPi
|
|
121
|
+
# Allow each upload to fail, in which case the whole job will also fail.
|
|
122
|
+
- status=0
|
|
123
|
+
- pixi run -e deploy --as-is twine upload -u gitlab-ci-token -p ${CI_JOB_TOKEN} --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/* || status=$?
|
|
124
|
+
- pixi run -e deploy --as-is twine upload -u ${TWINE_USERNAME} -p ${TWINE_PASSWORD} dist/* || status=$?
|
|
125
|
+
- exit $status
|
|
126
|
+
# Only build and deploy package from the main branch.
|
|
127
|
+
rules:
|
|
128
|
+
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
|
|
129
|
+
interruptible: true
|
|
130
|
+
artifacts:
|
|
131
|
+
expire_in: 1h
|
|
132
|
+
paths:
|
|
133
|
+
- dist
|
|
134
|
+
tags:
|
|
135
|
+
- ubuntu
|
|
136
|
+
|
|
137
|
+
# ===== Build documentation. =====
|
|
138
|
+
docs:
|
|
139
|
+
stage: build
|
|
140
|
+
needs: []
|
|
141
|
+
script:
|
|
142
|
+
- pixi install -e docs-complete --locked
|
|
143
|
+
- cd docs
|
|
144
|
+
- pixi run -e docs-complete --as-is sphinx-build source build
|
|
145
|
+
interruptible: true
|
|
146
|
+
artifacts:
|
|
147
|
+
expire_in: 2h
|
|
148
|
+
paths:
|
|
149
|
+
- docs/build
|
|
150
|
+
tags:
|
|
151
|
+
- ubuntu
|
|
152
|
+
|
|
153
|
+
# ===== Deploy documentation. =====
|
|
154
|
+
pages:
|
|
155
|
+
stage: deploy
|
|
156
|
+
needs:
|
|
157
|
+
- docs
|
|
158
|
+
dependencies:
|
|
159
|
+
- docs
|
|
160
|
+
script:
|
|
161
|
+
- mv docs/build public
|
|
162
|
+
# Deploy jobs must not be interrupted.
|
|
163
|
+
interruptible: false
|
|
164
|
+
artifacts:
|
|
165
|
+
expire_in: 1h
|
|
166
|
+
paths:
|
|
167
|
+
- public
|
|
168
|
+
# Only upload from main branch.
|
|
169
|
+
rules:
|
|
170
|
+
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
|
|
171
|
+
tags:
|
|
172
|
+
- ubuntu
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 4.3.4
|
|
4
|
+
|
|
5
|
+
- ~~Scan dependencies using pip-audit.~~ (!83)
|
|
6
|
+
- Moved CI from Poetry to pixi. (!84)
|
|
7
|
+
- Updated Yeo-Johnson transformation after Scipy 1.7. (!84)
|
|
8
|
+
- Support python 3.15. TensorFlow is allowed only till 3.13 included. (!84)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## 4.3.3
|
|
12
|
+
|
|
13
|
+
- Updated SMT to 2.9.4 and in turn Windows pipeline to python 3.13. (!79)
|
|
14
|
+
- Removed license file, since it's already specified in pyproject.toml. (!80)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## 4.3.2
|
|
18
|
+
|
|
19
|
+
- Support python 3.13. (!77)
|
|
20
|
+
- Since SMT 2.9.3 does not support python 3.13, the Windows pipeline is still based on python 3.12. (!77)
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## 4.3.1
|
|
24
|
+
|
|
25
|
+
- Switched surrogate model inference for TensorFlow models from model.predict() to direct model(...) (call) yielding ~100× speed-up with only negligible numerical differences. (!78)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## 4.3.0
|
|
29
|
+
|
|
30
|
+
- Update to Poetry 2. (!76)
|
|
31
|
+
- Update to TensorFlow 2.19. (!76)
|
|
32
|
+
- Minor changes to installation extras. (!76)
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: surrogates_interface
|
|
3
|
+
Version: 4.3.4
|
|
4
|
+
Summary: Interface for surrogate models.
|
|
5
|
+
Project-URL: repository, https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface
|
|
6
|
+
Project-URL: documentation, https://surrogate-models.pages.windenergy.dtu.dk/surrogate-models-interface
|
|
7
|
+
Author: DTU Wind and Energy Systems
|
|
8
|
+
Maintainer-email: Riccardo Riva <ricriv@dtu.dk>, Mads Mølgaard Pedersen <mmpe@dtu.dk>
|
|
9
|
+
License: MIT
|
|
10
|
+
Requires-Python: <3.16,>=3.11
|
|
11
|
+
Requires-Dist: h5py<4.0.0,>=3.10.0
|
|
12
|
+
Requires-Dist: numpy<3.0.0,>=1.10.0
|
|
13
|
+
Provides-Extra: audit
|
|
14
|
+
Requires-Dist: pip-audit<3.0.0,>=2.0.0; extra == 'audit'
|
|
15
|
+
Provides-Extra: deploy
|
|
16
|
+
Requires-Dist: build; extra == 'deploy'
|
|
17
|
+
Requires-Dist: twine; extra == 'deploy'
|
|
18
|
+
Provides-Extra: dev
|
|
19
|
+
Requires-Dist: spyder-kernels; extra == 'dev'
|
|
20
|
+
Provides-Extra: docs
|
|
21
|
+
Requires-Dist: numpydoc<2.0.0,>=1.8.0; extra == 'docs'
|
|
22
|
+
Requires-Dist: pydata-sphinx-theme<1.0.0,>=0.16.1; extra == 'docs'
|
|
23
|
+
Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == 'docs'
|
|
24
|
+
Requires-Dist: sphinx-design<1.0.0,>=0.6.0; extra == 'docs'
|
|
25
|
+
Requires-Dist: sphinx-sitemap<3.0.0,>=2.6.0; extra == 'docs'
|
|
26
|
+
Requires-Dist: sphinx<10.0.0,>=8.0.0; extra == 'docs'
|
|
27
|
+
Provides-Extra: lint
|
|
28
|
+
Requires-Dist: black<27.0.0,>=26.0.0; extra == 'lint'
|
|
29
|
+
Requires-Dist: codespell<3.0.0,>=2.4.0; extra == 'lint'
|
|
30
|
+
Requires-Dist: flake8<8.0.0,>=7.0.0; extra == 'lint'
|
|
31
|
+
Requires-Dist: isort<10.0.0,>=9.0.0; extra == 'lint'
|
|
32
|
+
Provides-Extra: om
|
|
33
|
+
Requires-Dist: openmdao<4.0.0,>=3.0.0; extra == 'om'
|
|
34
|
+
Provides-Extra: sklearn
|
|
35
|
+
Requires-Dist: scikit-learn<2.0.0,>=1.4.0; extra == 'sklearn'
|
|
36
|
+
Provides-Extra: smt
|
|
37
|
+
Requires-Dist: matplotlib<4.0.0,>=3.0.0; extra == 'smt'
|
|
38
|
+
Requires-Dist: smt<3.0.0,>=2.0.0; extra == 'smt'
|
|
39
|
+
Provides-Extra: test
|
|
40
|
+
Requires-Dist: pytest-cov<8.0.0,>=7.0.0; extra == 'test'
|
|
41
|
+
Requires-Dist: pytest<10.0.0,>=9.0.0; extra == 'test'
|
|
42
|
+
Provides-Extra: tf
|
|
43
|
+
Requires-Dist: tensorflow-io-gcs-filesystem==0.31.0; (python_version < '3.12') and extra == 'tf'
|
|
44
|
+
Requires-Dist: tensorflow<3.0.0,>=2.10.0; (python_version < '3.14') and extra == 'tf'
|
|
45
|
+
Provides-Extra: torch
|
|
46
|
+
Requires-Dist: keras<4.0.0,>=3.0.0; extra == 'torch'
|
|
47
|
+
Requires-Dist: torch<3.0.0,>=2.0.0; (sys_platform != 'win32') and extra == 'torch'
|
|
48
|
+
Requires-Dist: torch<3.0.0,>=2.0.0; (sys_platform == 'win32' and python_version < '3.15') and extra == 'torch'
|
|
49
|
+
Description-Content-Type: text/markdown
|
|
50
|
+
|
|
51
|
+
# Surrogate Models Interface
|
|
52
|
+
|
|
53
|
+
[](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
|
|
54
|
+
[](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
|
|
55
|
+
[](https://github.com/psf/black)
|
|
56
|
+
[](https://pixi.sh)
|
|
57
|
+
[](https://opensource.org/licenses/MIT)
|
|
58
|
+
[](https://doi.org/10.5281/zenodo.8282614)
|
|
59
|
+
|
|
60
|
+
Provides a common interface to several surrogate models, including an OpenMDAO wrapper.
|
|
61
|
+
|
|
62
|
+
The documentation is available at: https://surrogate-models.pages.windenergy.dtu.dk/surrogate-models-interface
|
|
63
|
+
|
|
64
|
+
This package is available from PyPi: https://pypi.org/project/surrogates_interface/
|
|
@@ -3,10 +3,12 @@
|
|
|
3
3
|
[](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
|
|
4
4
|
[](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
|
|
5
5
|
[](https://github.com/psf/black)
|
|
6
|
-
[](https://pixi.sh)
|
|
7
7
|
[](https://opensource.org/licenses/MIT)
|
|
8
8
|
[](https://doi.org/10.5281/zenodo.8282614)
|
|
9
9
|
|
|
10
10
|
Provides a common interface to several surrogate models, including an OpenMDAO wrapper.
|
|
11
11
|
|
|
12
12
|
The documentation is available at: https://surrogate-models.pages.windenergy.dtu.dk/surrogate-models-interface
|
|
13
|
+
|
|
14
|
+
This package is available from PyPi: https://pypi.org/project/surrogates_interface/
|
|
@@ -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,99 @@
|
|
|
1
|
+
# Configuration file for the Sphinx documentation builder.
|
|
2
|
+
#
|
|
3
|
+
# This file only contains a selection of the most common options. For a full
|
|
4
|
+
# list see the documentation:
|
|
5
|
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
6
|
+
|
|
7
|
+
# -- Path setup --------------------------------------------------------------
|
|
8
|
+
|
|
9
|
+
# If extensions (or modules to document with autodoc) are in another directory,
|
|
10
|
+
# add these directories to sys.path here. If the directory is relative to the
|
|
11
|
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
12
|
+
#
|
|
13
|
+
import os
|
|
14
|
+
import sys
|
|
15
|
+
import surrogates_interface
|
|
16
|
+
|
|
17
|
+
sys.path.insert(0, os.path.abspath("../.."))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
# -- Project information -----------------------------------------------------
|
|
21
|
+
|
|
22
|
+
project = "Surrogate Models Interface"
|
|
23
|
+
copyright = "2023, DTU Wind and Energy Systems"
|
|
24
|
+
author = "DTU Wind and Energy Systems"
|
|
25
|
+
|
|
26
|
+
# The full version, including alpha/beta/rc tags
|
|
27
|
+
release = surrogates_interface.__version__
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
# -- General configuration ---------------------------------------------------
|
|
31
|
+
|
|
32
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
|
33
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
34
|
+
# ones.
|
|
35
|
+
extensions = [
|
|
36
|
+
"sphinx.ext.autodoc",
|
|
37
|
+
"sphinx.ext.mathjax",
|
|
38
|
+
"sphinx.ext.doctest",
|
|
39
|
+
"numpydoc",
|
|
40
|
+
# 'sphinx.ext.autosummary', # Loaded by numpydoc
|
|
41
|
+
"sphinx.ext.napoleon",
|
|
42
|
+
"sphinx.ext.viewcode",
|
|
43
|
+
"sphinx_copybutton",
|
|
44
|
+
"sphinx_sitemap",
|
|
45
|
+
"sphinx_design",
|
|
46
|
+
]
|
|
47
|
+
|
|
48
|
+
numpydoc_class_members_toctree = False
|
|
49
|
+
|
|
50
|
+
autodoc_default_options = {
|
|
51
|
+
"private-members": True,
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
# Add any paths that contain templates here, relative to this directory.
|
|
55
|
+
templates_path = ["_templates"]
|
|
56
|
+
|
|
57
|
+
# List of patterns, relative to source directory, that match files and
|
|
58
|
+
# directories to ignore when looking for source files.
|
|
59
|
+
# This pattern also affects html_static_path and html_extra_path.
|
|
60
|
+
exclude_patterns = []
|
|
61
|
+
|
|
62
|
+
# Needed to generate the site map.
|
|
63
|
+
html_baseurl = "https://surrogate-models.pages.windenergy.dtu.dk/surrogate-models-interface/"
|
|
64
|
+
sitemap_url_scheme = "{link}"
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
# -- Options for HTML output -------------------------------------------------
|
|
68
|
+
|
|
69
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
70
|
+
# a list of builtin themes.
|
|
71
|
+
#
|
|
72
|
+
html_theme = "pydata_sphinx_theme"
|
|
73
|
+
|
|
74
|
+
html_theme_options = {
|
|
75
|
+
"logo": {
|
|
76
|
+
"text": project,
|
|
77
|
+
},
|
|
78
|
+
"icon_links": [
|
|
79
|
+
{
|
|
80
|
+
# Label for this link
|
|
81
|
+
"name": "GitLab",
|
|
82
|
+
# URL where the link will redirect
|
|
83
|
+
"url": "https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface", # required
|
|
84
|
+
# Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
|
|
85
|
+
"icon": "fa-brands fa-square-gitlab",
|
|
86
|
+
# The type of image to be used (see below for details)
|
|
87
|
+
"type": "fontawesome",
|
|
88
|
+
}
|
|
89
|
+
]
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
|
93
|
+
# relative to this directory. They are copied after the builtin static files,
|
|
94
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
95
|
+
# html_static_path = ["_static"]
|
|
96
|
+
|
|
97
|
+
html_extra_path = ["robots.txt",
|
|
98
|
+
"search_engines_indexing",
|
|
99
|
+
]
|