PyOptik 0.7.11__tar.gz → 0.7.15.post0__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.
Files changed (75) hide show
  1. pyoptik-0.7.15.post0/.github/dependabot.yml +11 -0
  2. pyoptik-0.7.15.post0/.github/workflows/deploy_workflow.yml +53 -0
  3. pyoptik-0.7.15.post0/.gitignore +15 -0
  4. pyoptik-0.7.15.post0/.readthedocs.yml +35 -0
  5. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PKG-INFO +39 -26
  6. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik/__init__.py +7 -0
  7. pyoptik-0.7.15.post0/PyOptik/_version.py +16 -0
  8. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik.egg-info/PKG-INFO +39 -26
  9. pyoptik-0.7.15.post0/PyOptik.egg-info/SOURCES.txt +60 -0
  10. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik.egg-info/requires.txt +6 -9
  11. pyoptik-0.7.15.post0/PyOptik.egg-info/top_level.txt +1 -0
  12. pyoptik-0.7.15.post0/docs/Makefile +19 -0
  13. pyoptik-0.7.15.post0/docs/examples/README.rst +6 -0
  14. pyoptik-0.7.15.post0/docs/images/logo.png +0 -0
  15. pyoptik-0.7.15.post0/docs/make.bat +35 -0
  16. pyoptik-0.7.15.post0/docs/source/_static/default.css +19 -0
  17. pyoptik-0.7.15.post0/docs/source/code.rst +16 -0
  18. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/source/conf.py +6 -17
  19. pyoptik-0.7.15.post0/docs/source/gallery/add_material.ipynb +43 -0
  20. pyoptik-0.7.15.post0/docs/source/gallery/add_material.rst +68 -0
  21. pyoptik-0.7.15.post0/docs/source/gallery/add_material_codeobj.pickle +0 -0
  22. pyoptik-0.7.15.post0/docs/source/gallery/get_values.ipynb +43 -0
  23. pyoptik-0.7.15.post0/docs/source/gallery/get_values.rst +66 -0
  24. pyoptik-0.7.15.post0/docs/source/gallery/get_values_codeobj.pickle +0 -0
  25. pyoptik-0.7.15.post0/docs/source/gallery/images/sphx_glr_plot_sellmeier_0_001.png +0 -0
  26. pyoptik-0.7.15.post0/docs/source/gallery/images/sphx_glr_plot_sellmeier_1_001.png +0 -0
  27. pyoptik-0.7.15.post0/docs/source/gallery/images/thumb/sphx_glr_add_material_thumb.png +0 -0
  28. pyoptik-0.7.15.post0/docs/source/gallery/images/thumb/sphx_glr_get_values_thumb.png +0 -0
  29. pyoptik-0.7.15.post0/docs/source/gallery/images/thumb/sphx_glr_plot_sellmeier_0_thumb.png +0 -0
  30. pyoptik-0.7.15.post0/docs/source/gallery/images/thumb/sphx_glr_plot_sellmeier_1_thumb.png +0 -0
  31. pyoptik-0.7.15.post0/docs/source/gallery/index.rst +103 -0
  32. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_0.ipynb +43 -0
  33. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_0.py.md5 +1 -0
  34. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_0.rst +225 -0
  35. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_0_codeobj.pickle +0 -0
  36. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_1.ipynb +43 -0
  37. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_1.py.md5 +1 -0
  38. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_1.rst +225 -0
  39. pyoptik-0.7.15.post0/docs/source/gallery/plot_sellmeier_1_codeobj.pickle +0 -0
  40. pyoptik-0.7.15.post0/docs/source/gallery/sg_execution_times.rst +19 -0
  41. pyoptik-0.7.15.post0/docs/source/index.rst +16 -0
  42. pyoptik-0.7.15.post0/docs/source/references.rst +4 -0
  43. pyoptik-0.7.15.post0/pyproject.toml +68 -0
  44. pyoptik-0.7.15.post0/setup.cfg +4 -0
  45. pyoptik-0.7.11/MANIFEST.in +0 -19
  46. pyoptik-0.7.11/PyOptik/VERSION +0 -1
  47. pyoptik-0.7.11/PyOptik/__pycache__/__init__.cpython-310.pyc +0 -0
  48. pyoptik-0.7.11/PyOptik/__pycache__/experiment_material.cpython-310.pyc +0 -0
  49. pyoptik-0.7.11/PyOptik/__pycache__/sellmeier_material.cpython-310.pyc +0 -0
  50. pyoptik-0.7.11/PyOptik.egg-info/SOURCES.txt +0 -35
  51. pyoptik-0.7.11/PyOptik.egg-info/top_level.txt +0 -3
  52. pyoptik-0.7.11/pyproject.toml +0 -10
  53. pyoptik-0.7.11/setup.cfg +0 -84
  54. pyoptik-0.7.11/setup.py +0 -6
  55. pyoptik-0.7.11/tests/__pycache__/__init__.cpython-310.pyc +0 -0
  56. pyoptik-0.7.11/tests/__pycache__/test_measurements.cpython-310.pyc +0 -0
  57. pyoptik-0.7.11/tests/__pycache__/test_sellmeier.cpython-310.pyc +0 -0
  58. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/LICENSE +0 -0
  59. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik/directories.py +0 -0
  60. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik/experiment_material.py +0 -0
  61. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik/sellmeier_material.py +0 -0
  62. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/PyOptik.egg-info/dependency_links.txt +0 -0
  63. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/README.rst +0 -0
  64. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/examples/measurements_tio2.py +0 -0
  65. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/examples/measurements_water.py +0 -0
  66. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/examples/sellmeier_bk7.py +0 -0
  67. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/examples/sellmeier_sf5.py +0 -0
  68. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/examples/sellmeier_silica.py +0 -0
  69. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/source/gallery/add_material.py +0 -0
  70. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/source/gallery/get_values.py +0 -0
  71. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/source/gallery/plot_sellmeier_0.py +0 -0
  72. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/docs/source/gallery/plot_sellmeier_1.py +0 -0
  73. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/tests/__init__.py +0 -0
  74. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/tests/test_measurements.py +0 -0
  75. {pyoptik-0.7.11 → pyoptik-0.7.15.post0}/tests/test_sellmeier.py +0 -0
@@ -0,0 +1,11 @@
1
+ # Specify reviewers for pull requests
2
+
3
+ version: 2
4
+ updates:
5
+ - package-ecosystem: "pip"
6
+ directory: "/"
7
+ target-branch: "master"
8
+ schedule:
9
+ interval: "weekly"
10
+ day: "sunday"
11
+ time: "09:00"
@@ -0,0 +1,53 @@
1
+ name: Deploy
2
+
3
+ on:
4
+ push:
5
+ branches: [ "master" ]
6
+ tags:
7
+ - '*'
8
+ pull_request:
9
+ branches: [ "master" ]
10
+
11
+ permissions:
12
+ contents: write
13
+
14
+ jobs:
15
+ build_pure_python:
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - uses: MartinPdeS/MPSActions/build_pure_python_package@master
19
+ with:
20
+ python-version: '3.10'
21
+
22
+ publish_coverage:
23
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
24
+ needs: [build_pure_python]
25
+ runs-on: ubuntu-latest
26
+ steps:
27
+ - uses: MartinPdeS/MPSActions/publish_coverage@master
28
+ with:
29
+ package-name: PyOptik
30
+ python-version: "3.10"
31
+ auth: ${{ secrets.GIST_TOKEN }}
32
+ gistID: 8fa5a7d93dc020b1f624012220f6ebbd
33
+
34
+ publish_documentation:
35
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
36
+ needs: [build_pure_python]
37
+ runs-on: ubuntu-latest
38
+ steps:
39
+ - uses: MartinPdeS/MPSActions/publish_documentation@master
40
+ with:
41
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42
+ package-name: PyOptik
43
+ python-version: "3.10" #no documentation for python 3.7 (pickle5 not present˘)
44
+
45
+ publish_wheel:
46
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
47
+ needs: [build_pure_python, publish_documentation, publish_coverage]
48
+ runs-on: ubuntu-latest
49
+ steps:
50
+ - uses: MartinPdeS/MPSActions/publish_pypi@master
51
+ with:
52
+ python-version: "3.10"
53
+ password: ${{ secrets.PYPI_API_TOKEN }}
@@ -0,0 +1,15 @@
1
+ *.DS_store
2
+ *.ipynb_checkpoints*
3
+ *__pycache__*
4
+ *.so
5
+ *.pytest_cache
6
+
7
+ dist
8
+ build
9
+ *.egg*
10
+ perso/
11
+
12
+ CMakeCache.txt
13
+ CMakeFiles
14
+ install_manifest.txt
15
+ cmake_install.cmake
@@ -0,0 +1,35 @@
1
+ # .readthedocs.yml
2
+ # Read the Docs configuration file
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+ # Required
6
+ version: 2
7
+
8
+ submodules:
9
+ include: all
10
+ recursive: true
11
+
12
+ build:
13
+ os: ubuntu-22.04
14
+
15
+
16
+ tools:
17
+ python: "3.10"
18
+ jobs:
19
+ pre_install:
20
+ - Xvfb :99 &
21
+ - export DISPLAY=:99
22
+ - cd docs && rm -rf source/gallery
23
+ - sleep 3
24
+
25
+ python:
26
+ install:
27
+ - method: pip
28
+ path: .
29
+ extra_requirements:
30
+ - documentation
31
+
32
+ sphinx:
33
+ builder: html
34
+ configuration: docs/source/conf.py
35
+ fail_on_warning: false
@@ -1,18 +1,33 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: PyOptik
3
- Version: 0.7.11
4
- Summary: A package/library for refractive index values.
5
- Home-page: https://github.com/MartinPdeS/PyOptik
6
- Author: Martin Poinsinet de Sivry
7
- Author-email: Martin.poinsinet.de.sivry@gmail.com
8
- License: MIT
9
- Keywords: refractive index
10
- Platform: unix
11
- Platform: linux
12
- Platform: osx
3
+ Version: 0.7.15.post0
4
+ Summary: A package for refractive index values.
5
+ Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2020 Martin de Sivry
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+ Keywords: refracive index,optics
13
29
  Classifier: Programming Language :: Python
14
30
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.10
16
31
  Classifier: Programming Language :: Python :: 3.11
17
32
  Classifier: Programming Language :: Python :: 3.12
18
33
  Classifier: Programming Language :: Python :: Implementation :: CPython
@@ -20,22 +35,15 @@ Classifier: Development Status :: 4 - Beta
20
35
  Classifier: Topic :: Scientific/Engineering :: Physics
21
36
  Classifier: License :: OSI Approved :: MIT License
22
37
  Classifier: Intended Audience :: Science/Research
38
+ Requires-Python: >=3.10
23
39
  Description-Content-Type: text/x-rst
24
40
  License-File: LICENSE
25
- Requires-Dist: pydantic==2.6.3
26
- Requires-Dist: matplotlib==3.8.2
27
- Requires-Dist: numpy>=1.26.0
28
- Requires-Dist: requests==2.31.0
29
- Requires-Dist: pandas==2.1.1
30
- Requires-Dist: bs4==0.0.1
31
- Requires-Dist: MPSTools==0.2.3
32
- Requires-Dist: MPSPlots>=1.4.2
33
- Provides-Extra: documentation
34
- Requires-Dist: numpydoc==1.6.0; extra == "documentation"
35
- Requires-Dist: sphinx>=5.1.1; extra == "documentation"
36
- Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
37
- Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
38
- Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
41
+ Requires-Dist: pydantic>=2.6.3
42
+ Requires-Dist: numpy
43
+ Requires-Dist: scipy
44
+ Requires-Dist: MPSTools
45
+ Requires-Dist: MPSPlots>=1.4.5
46
+ Requires-Dist: tabulate
39
47
  Provides-Extra: testing
40
48
  Requires-Dist: pytest>=0.6; extra == "testing"
41
49
  Requires-Dist: pytest-cov>=2.0; extra == "testing"
@@ -44,7 +52,12 @@ Requires-Dist: mypy>=0.910; extra == "testing"
44
52
  Requires-Dist: flake8>=3.9; extra == "testing"
45
53
  Requires-Dist: tox>=3.24; extra == "testing"
46
54
  Requires-Dist: coverage==6.5.0; extra == "testing"
47
- Requires-Dist: PyMieScatt==1.8.1.1; extra == "testing"
55
+ Provides-Extra: documentation
56
+ Requires-Dist: numpydoc==1.6.0; extra == "documentation"
57
+ Requires-Dist: sphinx>=5.1.1; extra == "documentation"
58
+ Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
59
+ Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
60
+ Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
48
61
 
49
62
  |Logo|
50
63
 
@@ -4,6 +4,13 @@ import numpy
4
4
  import pandas
5
5
 
6
6
 
7
+ try:
8
+ from ._version import version as __version__ # noqa: F401
9
+
10
+ except ImportError:
11
+ __version__ = "0.0.0"
12
+
13
+
7
14
  class UsualMaterial:
8
15
  BK7 = Sellmeier('BK7')
9
16
  FusedSilica = Sellmeier('silica')
@@ -0,0 +1,16 @@
1
+ # file generated by setuptools_scm
2
+ # don't change, don't track in version control
3
+ TYPE_CHECKING = False
4
+ if TYPE_CHECKING:
5
+ from typing import Tuple, Union
6
+ VERSION_TUPLE = Tuple[Union[int, str], ...]
7
+ else:
8
+ VERSION_TUPLE = object
9
+
10
+ version: str
11
+ __version__: str
12
+ __version_tuple__: VERSION_TUPLE
13
+ version_tuple: VERSION_TUPLE
14
+
15
+ __version__ = version = '0.7.15.post0'
16
+ __version_tuple__ = version_tuple = (0, 7, 15)
@@ -1,18 +1,33 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: PyOptik
3
- Version: 0.7.11
4
- Summary: A package/library for refractive index values.
5
- Home-page: https://github.com/MartinPdeS/PyOptik
6
- Author: Martin Poinsinet de Sivry
7
- Author-email: Martin.poinsinet.de.sivry@gmail.com
8
- License: MIT
9
- Keywords: refractive index
10
- Platform: unix
11
- Platform: linux
12
- Platform: osx
3
+ Version: 0.7.15.post0
4
+ Summary: A package for refractive index values.
5
+ Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2020 Martin de Sivry
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+ Keywords: refracive index,optics
13
29
  Classifier: Programming Language :: Python
14
30
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.10
16
31
  Classifier: Programming Language :: Python :: 3.11
17
32
  Classifier: Programming Language :: Python :: 3.12
18
33
  Classifier: Programming Language :: Python :: Implementation :: CPython
@@ -20,22 +35,15 @@ Classifier: Development Status :: 4 - Beta
20
35
  Classifier: Topic :: Scientific/Engineering :: Physics
21
36
  Classifier: License :: OSI Approved :: MIT License
22
37
  Classifier: Intended Audience :: Science/Research
38
+ Requires-Python: >=3.10
23
39
  Description-Content-Type: text/x-rst
24
40
  License-File: LICENSE
25
- Requires-Dist: pydantic==2.6.3
26
- Requires-Dist: matplotlib==3.8.2
27
- Requires-Dist: numpy>=1.26.0
28
- Requires-Dist: requests==2.31.0
29
- Requires-Dist: pandas==2.1.1
30
- Requires-Dist: bs4==0.0.1
31
- Requires-Dist: MPSTools==0.2.3
32
- Requires-Dist: MPSPlots>=1.4.2
33
- Provides-Extra: documentation
34
- Requires-Dist: numpydoc==1.6.0; extra == "documentation"
35
- Requires-Dist: sphinx>=5.1.1; extra == "documentation"
36
- Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
37
- Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
38
- Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
41
+ Requires-Dist: pydantic>=2.6.3
42
+ Requires-Dist: numpy
43
+ Requires-Dist: scipy
44
+ Requires-Dist: MPSTools
45
+ Requires-Dist: MPSPlots>=1.4.5
46
+ Requires-Dist: tabulate
39
47
  Provides-Extra: testing
40
48
  Requires-Dist: pytest>=0.6; extra == "testing"
41
49
  Requires-Dist: pytest-cov>=2.0; extra == "testing"
@@ -44,7 +52,12 @@ Requires-Dist: mypy>=0.910; extra == "testing"
44
52
  Requires-Dist: flake8>=3.9; extra == "testing"
45
53
  Requires-Dist: tox>=3.24; extra == "testing"
46
54
  Requires-Dist: coverage==6.5.0; extra == "testing"
47
- Requires-Dist: PyMieScatt==1.8.1.1; extra == "testing"
55
+ Provides-Extra: documentation
56
+ Requires-Dist: numpydoc==1.6.0; extra == "documentation"
57
+ Requires-Dist: sphinx>=5.1.1; extra == "documentation"
58
+ Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
59
+ Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
60
+ Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
48
61
 
49
62
  |Logo|
50
63
 
@@ -0,0 +1,60 @@
1
+ .gitignore
2
+ .readthedocs.yml
3
+ LICENSE
4
+ README.rst
5
+ pyproject.toml
6
+ .github/dependabot.yml
7
+ .github/workflows/deploy_workflow.yml
8
+ PyOptik/__init__.py
9
+ PyOptik/_version.py
10
+ PyOptik/directories.py
11
+ PyOptik/experiment_material.py
12
+ PyOptik/sellmeier_material.py
13
+ PyOptik.egg-info/PKG-INFO
14
+ PyOptik.egg-info/SOURCES.txt
15
+ PyOptik.egg-info/dependency_links.txt
16
+ PyOptik.egg-info/requires.txt
17
+ PyOptik.egg-info/top_level.txt
18
+ docs/Makefile
19
+ docs/make.bat
20
+ docs/examples/README.rst
21
+ docs/examples/measurements_tio2.py
22
+ docs/examples/measurements_water.py
23
+ docs/examples/sellmeier_bk7.py
24
+ docs/examples/sellmeier_sf5.py
25
+ docs/examples/sellmeier_silica.py
26
+ docs/images/logo.png
27
+ docs/source/code.rst
28
+ docs/source/conf.py
29
+ docs/source/index.rst
30
+ docs/source/references.rst
31
+ docs/source/_static/default.css
32
+ docs/source/gallery/add_material.ipynb
33
+ docs/source/gallery/add_material.py
34
+ docs/source/gallery/add_material.rst
35
+ docs/source/gallery/add_material_codeobj.pickle
36
+ docs/source/gallery/get_values.ipynb
37
+ docs/source/gallery/get_values.py
38
+ docs/source/gallery/get_values.rst
39
+ docs/source/gallery/get_values_codeobj.pickle
40
+ docs/source/gallery/index.rst
41
+ docs/source/gallery/plot_sellmeier_0.ipynb
42
+ docs/source/gallery/plot_sellmeier_0.py
43
+ docs/source/gallery/plot_sellmeier_0.py.md5
44
+ docs/source/gallery/plot_sellmeier_0.rst
45
+ docs/source/gallery/plot_sellmeier_0_codeobj.pickle
46
+ docs/source/gallery/plot_sellmeier_1.ipynb
47
+ docs/source/gallery/plot_sellmeier_1.py
48
+ docs/source/gallery/plot_sellmeier_1.py.md5
49
+ docs/source/gallery/plot_sellmeier_1.rst
50
+ docs/source/gallery/plot_sellmeier_1_codeobj.pickle
51
+ docs/source/gallery/sg_execution_times.rst
52
+ docs/source/gallery/images/sphx_glr_plot_sellmeier_0_001.png
53
+ docs/source/gallery/images/sphx_glr_plot_sellmeier_1_001.png
54
+ docs/source/gallery/images/thumb/sphx_glr_add_material_thumb.png
55
+ docs/source/gallery/images/thumb/sphx_glr_get_values_thumb.png
56
+ docs/source/gallery/images/thumb/sphx_glr_plot_sellmeier_0_thumb.png
57
+ docs/source/gallery/images/thumb/sphx_glr_plot_sellmeier_1_thumb.png
58
+ tests/__init__.py
59
+ tests/test_measurements.py
60
+ tests/test_sellmeier.py
@@ -1,11 +1,9 @@
1
- pydantic==2.6.3
2
- matplotlib==3.8.2
3
- numpy>=1.26.0
4
- requests==2.31.0
5
- pandas==2.1.1
6
- bs4==0.0.1
7
- MPSTools==0.2.3
8
- MPSPlots>=1.4.2
1
+ pydantic>=2.6.3
2
+ numpy
3
+ scipy
4
+ MPSTools
5
+ MPSPlots>=1.4.5
6
+ tabulate
9
7
 
10
8
  [documentation]
11
9
  numpydoc==1.6.0
@@ -22,4 +20,3 @@ mypy>=0.910
22
20
  flake8>=3.9
23
21
  tox>=3.24
24
22
  coverage==6.5.0
25
- PyMieScatt==1.8.1.1
@@ -0,0 +1 @@
1
+ PyOptik
@@ -0,0 +1,19 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ SOURCEDIR = source
8
+ BUILDDIR = build
9
+
10
+ # Put it first so that "make" without argument is like "make help".
11
+ help:
12
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13
+
14
+ .PHONY: help Makefile
15
+
16
+ # Catch-all target: route all unknown targets to Sphinx using the new
17
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18
+ %: Makefile
19
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,6 @@
1
+ .. _examples_gallery:
2
+
3
+ Examples
4
+ ========
5
+
6
+ A gallery of examples and that showcase how PyOptik can be used. Some examples demonstrate the use of the API in general and some demonstrate specific applications in tutorial form.
@@ -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
+ if "%1" == "" goto help
14
+
15
+ %SPHINXBUILD% >NUL 2>NUL
16
+ if errorlevel 9009 (
17
+ echo.
18
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19
+ echo.installed, then set the SPHINXBUILD environment variable to point
20
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
21
+ echo.may add the Sphinx directory to PATH.
22
+ echo.
23
+ echo.If you don't have Sphinx installed, grab it from
24
+ echo.http://sphinx-doc.org/
25
+ exit /b 1
26
+ )
27
+
28
+ %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29
+ goto end
30
+
31
+ :help
32
+ %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33
+
34
+ :end
35
+ popd
@@ -0,0 +1,19 @@
1
+ /* Additional styling for the PyData Sphinx theme. */
2
+
3
+ /* Use hyperlink color for grid-item-cards.
4
+ TODO find a way to only apply this to grid-item-cards that link somewhere */
5
+ .sd-card-title {
6
+ color: var(--pst-color-link);
7
+ }
8
+
9
+ /* Use text base color for hyperlinks in code cells. Pygments "default" theme
10
+ doesn't seem to set this color, so the default light blue link color is applied
11
+ which has a very low contrast with the background. */
12
+ div.highlight a {
13
+ color: var(--pst-color-text-base);
14
+ }
15
+
16
+ /* Stack components in footer vertically. */
17
+ .bd-footer .footer-items__end, .bd-footer .footer-items__start {
18
+ flex-direction: row;
19
+ }
@@ -0,0 +1,16 @@
1
+ :orphan:
2
+
3
+ .. _source_code:
4
+
5
+ Source code
6
+ ===========
7
+
8
+ SellMeier
9
+ ---------
10
+
11
+ .. autoclass:: PyOptik.sellmeier.Sellmeier
12
+ :members:
13
+ :inherited-members:
14
+ :member-order: bysource
15
+
16
+
@@ -6,12 +6,8 @@ from sphinx_gallery.sorting import FileNameSortKey
6
6
  from packaging.version import parse
7
7
  from MPSPlots.styles import use_mpsplots_style
8
8
 
9
-
10
- from PyOptik.directories import (
11
- project_path,
12
- doc_css_path,
13
- version_path,
14
- )
9
+ import PyOptik
10
+ from PyOptik.directories import project_path, doc_css_path
15
11
 
16
12
 
17
13
  sys.path.insert(0, project_path)
@@ -36,8 +32,7 @@ copyright = '2024, Martin Poinsinet de Sivry-Houle'
36
32
  author = 'Martin Poinsinet de Sivry-Houle'
37
33
 
38
34
 
39
- with open(version_path, "r+") as f:
40
- version = release = f.read()
35
+ version = PyOptik.__version__
41
36
 
42
37
 
43
38
  extensions = [
@@ -95,16 +90,10 @@ default_role = "autolink"
95
90
  pygments_style = "sphinx"
96
91
 
97
92
  # -- Sphinx-gallery configuration --------------------------------------------
93
+ binder_branch = "main"
98
94
 
99
- v = parse(release)
100
- if v.release is None:
101
- raise ValueError(f"Ill-formed version: {version!r}. Version should follow PEP440")
102
-
103
- if v.is_devrelease:
104
- binder_branch = "main"
105
- else:
106
- major, minor = v.release[:2]
107
- binder_branch = f"v{major}.{minor}.x"
95
+ major, minor = version[:2]
96
+ binder_branch = f"v{major}.{minor}.x"
108
97
 
109
98
  html_theme_options = {
110
99
  # Navigation bar
@@ -0,0 +1,43 @@
1
+ {
2
+ "cells": [
3
+ {
4
+ "cell_type": "markdown",
5
+ "metadata": {},
6
+ "source": [
7
+ "\n# Add hoc docstring\n"
8
+ ]
9
+ },
10
+ {
11
+ "cell_type": "code",
12
+ "execution_count": null,
13
+ "metadata": {
14
+ "collapsed": false
15
+ },
16
+ "outputs": [],
17
+ "source": [
18
+ "from PyOptik import DataBank\nfrom PyOptik.ExpData import SaveData\n\nprint(DataBank())\n\nurl = 'https://refractiveindex.info/data_csv.php?datafile=data/main/Si/Aspnes.yml'\n\nSaveData(name='SI', url=url)\n\nprint(DataBank())"
19
+ ]
20
+ }
21
+ ],
22
+ "metadata": {
23
+ "kernelspec": {
24
+ "display_name": "Python 3",
25
+ "language": "python",
26
+ "name": "python3"
27
+ },
28
+ "language_info": {
29
+ "codemirror_mode": {
30
+ "name": "ipython",
31
+ "version": 3
32
+ },
33
+ "file_extension": ".py",
34
+ "mimetype": "text/x-python",
35
+ "name": "python",
36
+ "nbconvert_exporter": "python",
37
+ "pygments_lexer": "ipython3",
38
+ "version": "3.11.0"
39
+ }
40
+ },
41
+ "nbformat": 4,
42
+ "nbformat_minor": 0
43
+ }
@@ -0,0 +1,68 @@
1
+
2
+ .. DO NOT EDIT.
3
+ .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
4
+ .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
5
+ .. "gallery/add_material.py"
6
+ .. LINE NUMBERS ARE GIVEN BELOW.
7
+
8
+ .. only:: html
9
+
10
+ .. note::
11
+ :class: sphx-glr-download-link-note
12
+
13
+ :ref:`Go to the end <sphx_glr_download_gallery_add_material.py>`
14
+ to download the full example code
15
+
16
+ .. rst-class:: sphx-glr-example-title
17
+
18
+ .. _sphx_glr_gallery_add_material.py:
19
+
20
+
21
+ Add hoc docstring
22
+ =================
23
+
24
+ .. GENERATED FROM PYTHON SOURCE LINES 6-17
25
+
26
+ .. code-block:: python3
27
+
28
+
29
+ from PyOptik import DataBank
30
+ from PyOptik.ExpData import SaveData
31
+
32
+ print(DataBank())
33
+
34
+ url = 'https://refractiveindex.info/data_csv.php?datafile=data/main/Si/Aspnes.yml'
35
+
36
+ SaveData(name='SI', url=url)
37
+
38
+ print(DataBank())
39
+
40
+
41
+ .. rst-class:: sphx-glr-timing
42
+
43
+ **Total running time of the script:** (0 minutes 0.000 seconds)
44
+
45
+
46
+ .. _sphx_glr_download_gallery_add_material.py:
47
+
48
+ .. only:: html
49
+
50
+ .. container:: sphx-glr-footer sphx-glr-footer-example
51
+
52
+
53
+
54
+
55
+ .. container:: sphx-glr-download sphx-glr-download-python
56
+
57
+ :download:`Download Python source code: add_material.py <add_material.py>`
58
+
59
+ .. container:: sphx-glr-download sphx-glr-download-jupyter
60
+
61
+ :download:`Download Jupyter notebook: add_material.ipynb <add_material.ipynb>`
62
+
63
+
64
+ .. only:: html
65
+
66
+ .. rst-class:: sphx-glr-signature
67
+
68
+ `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_