pyetsimul 3.2.1__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 (206) hide show
  1. pyetsimul-3.2.1/.github/workflows/publish.yml +33 -0
  2. pyetsimul-3.2.1/.gitignore +215 -0
  3. pyetsimul-3.2.1/.readthedocs.yaml +19 -0
  4. pyetsimul-3.2.1/LICENSE +674 -0
  5. pyetsimul-3.2.1/PKG-INFO +20 -0
  6. pyetsimul-3.2.1/README.md +107 -0
  7. pyetsimul-3.2.1/docs/_static/images/eye_model_schematic.png +0 -0
  8. pyetsimul-3.2.1/docs/_static/images/eye_tracking_setup.png +0 -0
  9. pyetsimul-3.2.1/docs/api/core.rst +61 -0
  10. pyetsimul-3.2.1/docs/api/evaluation.rst +49 -0
  11. pyetsimul-3.2.1/docs/api/gaze_mapping.rst +28 -0
  12. pyetsimul-3.2.1/docs/api/geometry.rst +49 -0
  13. pyetsimul-3.2.1/docs/api/index.rst +14 -0
  14. pyetsimul-3.2.1/docs/api/optics.rst +33 -0
  15. pyetsimul-3.2.1/docs/api/simulation.rst +74 -0
  16. pyetsimul-3.2.1/docs/api/types.rst +28 -0
  17. pyetsimul-3.2.1/docs/api/visualization.rst +100 -0
  18. pyetsimul-3.2.1/docs/conf.py +61 -0
  19. pyetsimul-3.2.1/docs/getting_started.rst +94 -0
  20. pyetsimul-3.2.1/docs/guides/custom_gaze_model.md +1 -0
  21. pyetsimul-3.2.1/docs/guides/custom_variations.md +1 -0
  22. pyetsimul-3.2.1/docs/index.rst +91 -0
  23. pyetsimul-3.2.1/docs/theory/camera_and_lights.rst +84 -0
  24. pyetsimul-3.2.1/docs/theory/coordinate_systems.rst +234 -0
  25. pyetsimul-3.2.1/docs/theory/default_parameters.rst +49 -0
  26. pyetsimul-3.2.1/docs/theory/evaluation_workflow.rst +126 -0
  27. pyetsimul-3.2.1/docs/theory/eye_model.rst +161 -0
  28. pyetsimul-3.2.1/docs/theory/gaze_estimation_models.rst +143 -0
  29. pyetsimul-3.2.1/docs/theory/optical_calculations.rst +89 -0
  30. pyetsimul-3.2.1/examples/__init__.py +1 -0
  31. pyetsimul-3.2.1/examples/basic_usage_demo.py +67 -0
  32. pyetsimul-3.2.1/examples/camera_distortion.py +211 -0
  33. pyetsimul-3.2.1/examples/cornea_comparison_figure.py +139 -0
  34. pyetsimul-3.2.1/examples/custom_gaze_model.md +130 -0
  35. pyetsimul-3.2.1/examples/custom_gaze_model.py +240 -0
  36. pyetsimul-3.2.1/examples/custom_polynomial_example.py +80 -0
  37. pyetsimul-3.2.1/examples/data_generation_tutorial.ipynb +508 -0
  38. pyetsimul-3.2.1/examples/example.py +128 -0
  39. pyetsimul-3.2.1/examples/experiments/README.md +76 -0
  40. pyetsimul-3.2.1/examples/experiments/__init__.py +1 -0
  41. pyetsimul-3.2.1/examples/experiments/algorithm_comparison.py +142 -0
  42. pyetsimul-3.2.1/examples/experiments/config.py +174 -0
  43. pyetsimul-3.2.1/examples/experiments/data_generation.py +56 -0
  44. pyetsimul-3.2.1/examples/experiments/data_validation.py +296 -0
  45. pyetsimul-3.2.1/examples/experiments/homography_normalization_demo.py +102 -0
  46. pyetsimul-3.2.1/examples/experiments/polynomial_demo.py +108 -0
  47. pyetsimul-3.2.1/examples/eye_anatomy.py +84 -0
  48. pyetsimul-3.2.1/examples/eyelid_openness_comparison.py +83 -0
  49. pyetsimul-3.2.1/examples/eyelink1000plus.py +275 -0
  50. pyetsimul-3.2.1/examples/glint_noise_demo.py +104 -0
  51. pyetsimul-3.2.1/examples/multi_eye_tracking_setup.py +81 -0
  52. pyetsimul-3.2.1/examples/polynomial_multi_glint.py +270 -0
  53. pyetsimul-3.2.1/examples/pupil_decentration.py +243 -0
  54. pyetsimul-3.2.1/examples/realistic_pupil.py +52 -0
  55. pyetsimul-3.2.1/examples/realistic_pupil_comparison.py +120 -0
  56. pyetsimul-3.2.1/examples/run_all_examples.py +91 -0
  57. pyetsimul-3.2.1/examples/setup_visualization.py +40 -0
  58. pyetsimul-3.2.1/examples/simple_data_generation.py +85 -0
  59. pyetsimul-3.2.1/examples/stampe1993.py +252 -0
  60. pyetsimul-3.2.1/pyetsimul/__init__.py +39 -0
  61. pyetsimul-3.2.1/pyetsimul/camera_noise/__init__.py +8 -0
  62. pyetsimul-3.2.1/pyetsimul/camera_noise/glint_noise.py +114 -0
  63. pyetsimul-3.2.1/pyetsimul/core/__init__.py +24 -0
  64. pyetsimul-3.2.1/pyetsimul/core/camera.py +553 -0
  65. pyetsimul-3.2.1/pyetsimul/core/cornea.py +639 -0
  66. pyetsimul-3.2.1/pyetsimul/core/default_configs.py +145 -0
  67. pyetsimul-3.2.1/pyetsimul/core/eye.py +850 -0
  68. pyetsimul-3.2.1/pyetsimul/core/eye_operations.py +131 -0
  69. pyetsimul-3.2.1/pyetsimul/core/eye_tracker.py +349 -0
  70. pyetsimul-3.2.1/pyetsimul/core/eyelid.py +210 -0
  71. pyetsimul-3.2.1/pyetsimul/core/light.py +75 -0
  72. pyetsimul-3.2.1/pyetsimul/core/pupil.py +603 -0
  73. pyetsimul-3.2.1/pyetsimul/core/pupil_decentration.py +254 -0
  74. pyetsimul-3.2.1/pyetsimul/evaluation/__init__.py +8 -0
  75. pyetsimul-3.2.1/pyetsimul/evaluation/algorithm_comparison.py +294 -0
  76. pyetsimul-3.2.1/pyetsimul/evaluation/analysis_utils.py +49 -0
  77. pyetsimul-3.2.1/pyetsimul/evaluation/calibration_analysis.py +223 -0
  78. pyetsimul-3.2.1/pyetsimul/evaluation/calibration_utils.py +82 -0
  79. pyetsimul-3.2.1/pyetsimul/evaluation/gaze_accuracy.py +262 -0
  80. pyetsimul-3.2.1/pyetsimul/gaze_mapping/__init__.py +22 -0
  81. pyetsimul-3.2.1/pyetsimul/gaze_mapping/eyelink1000plus/__init__.py +11 -0
  82. pyetsimul-3.2.1/pyetsimul/gaze_mapping/eyelink1000plus/eyelink1000plus_gaze_model.py +261 -0
  83. pyetsimul-3.2.1/pyetsimul/gaze_mapping/eyelink1000plus/href.py +96 -0
  84. pyetsimul-3.2.1/pyetsimul/gaze_mapping/homography_normalization/__init__.py +15 -0
  85. pyetsimul-3.2.1/pyetsimul/gaze_mapping/homography_normalization/gaussian_process.py +71 -0
  86. pyetsimul-3.2.1/pyetsimul/gaze_mapping/homography_normalization/homography_normalization_gaze_model.py +300 -0
  87. pyetsimul-3.2.1/pyetsimul/gaze_mapping/homography_normalization/homography_normalization_state.py +95 -0
  88. pyetsimul-3.2.1/pyetsimul/gaze_mapping/homography_normalization/homography_normalization_utils.py +79 -0
  89. pyetsimul-3.2.1/pyetsimul/gaze_mapping/polynomial/__init__.py +17 -0
  90. pyetsimul-3.2.1/pyetsimul/gaze_mapping/polynomial/polynomial_descriptor.py +186 -0
  91. pyetsimul-3.2.1/pyetsimul/gaze_mapping/polynomial/polynomial_features.py +73 -0
  92. pyetsimul-3.2.1/pyetsimul/gaze_mapping/polynomial/polynomial_gaze_model.py +434 -0
  93. pyetsimul-3.2.1/pyetsimul/gaze_mapping/polynomial/polynomial_state.py +45 -0
  94. pyetsimul-3.2.1/pyetsimul/gaze_mapping/polynomial/polynomials.py +322 -0
  95. pyetsimul-3.2.1/pyetsimul/gaze_mapping/stampe1993/__init__.py +9 -0
  96. pyetsimul-3.2.1/pyetsimul/gaze_mapping/stampe1993/stampe1993_gaze_model.py +235 -0
  97. pyetsimul-3.2.1/pyetsimul/geometry/__init__.py +13 -0
  98. pyetsimul-3.2.1/pyetsimul/geometry/conversions.py +127 -0
  99. pyetsimul-3.2.1/pyetsimul/geometry/intersections.py +329 -0
  100. pyetsimul-3.2.1/pyetsimul/geometry/listings_law.py +49 -0
  101. pyetsimul-3.2.1/pyetsimul/geometry/plane_detection.py +163 -0
  102. pyetsimul-3.2.1/pyetsimul/geometry/utils.py +72 -0
  103. pyetsimul-3.2.1/pyetsimul/log.py +134 -0
  104. pyetsimul-3.2.1/pyetsimul/optics/__init__.py +8 -0
  105. pyetsimul-3.2.1/pyetsimul/optics/glint_size.py +139 -0
  106. pyetsimul-3.2.1/pyetsimul/optics/pupil_imaging.py +239 -0
  107. pyetsimul-3.2.1/pyetsimul/optics/reflections.py +424 -0
  108. pyetsimul-3.2.1/pyetsimul/optics/refractions.py +538 -0
  109. pyetsimul-3.2.1/pyetsimul/simulation/__init__.py +47 -0
  110. pyetsimul-3.2.1/pyetsimul/simulation/anatomy.py +247 -0
  111. pyetsimul-3.2.1/pyetsimul/simulation/composed_variation.py +98 -0
  112. pyetsimul-3.2.1/pyetsimul/simulation/config.py +66 -0
  113. pyetsimul-3.2.1/pyetsimul/simulation/core.py +56 -0
  114. pyetsimul-3.2.1/pyetsimul/simulation/data_generation.py +398 -0
  115. pyetsimul-3.2.1/pyetsimul/simulation/data_loading.py +42 -0
  116. pyetsimul-3.2.1/pyetsimul/simulation/eye_position.py +46 -0
  117. pyetsimul-3.2.1/pyetsimul/simulation/generic.py +72 -0
  118. pyetsimul-3.2.1/pyetsimul/simulation/grid_base.py +136 -0
  119. pyetsimul-3.2.1/pyetsimul/simulation/target_position.py +41 -0
  120. pyetsimul-3.2.1/pyetsimul/types/__init__.py +40 -0
  121. pyetsimul-3.2.1/pyetsimul/types/algorithms.py +44 -0
  122. pyetsimul-3.2.1/pyetsimul/types/geometry.py +820 -0
  123. pyetsimul-3.2.1/pyetsimul/types/imaging.py +143 -0
  124. pyetsimul-3.2.1/pyetsimul/utils/__init__.py +6 -0
  125. pyetsimul-3.2.1/pyetsimul/utils/eye_surface_points.py +85 -0
  126. pyetsimul-3.2.1/pyetsimul/utils/eyelid_surface_points.py +151 -0
  127. pyetsimul-3.2.1/pyetsimul/utils/filename.py +23 -0
  128. pyetsimul-3.2.1/pyetsimul/utils/rotation_helpers.py +148 -0
  129. pyetsimul-3.2.1/pyetsimul/utils/surface_points.py +48 -0
  130. pyetsimul-3.2.1/pyetsimul/visualization/__init__.py +51 -0
  131. pyetsimul-3.2.1/pyetsimul/visualization/analysis_plots.py +320 -0
  132. pyetsimul-3.2.1/pyetsimul/visualization/camera_view.py +203 -0
  133. pyetsimul-3.2.1/pyetsimul/visualization/coordinate_utils.py +158 -0
  134. pyetsimul-3.2.1/pyetsimul/visualization/eye_anatomy.py +329 -0
  135. pyetsimul-3.2.1/pyetsimul/visualization/gaze_accuracy_plots.py +230 -0
  136. pyetsimul-3.2.1/pyetsimul/visualization/integrated_plots.py +106 -0
  137. pyetsimul-3.2.1/pyetsimul/visualization/interactive.py +409 -0
  138. pyetsimul-3.2.1/pyetsimul/visualization/interactive_controls.py +151 -0
  139. pyetsimul-3.2.1/pyetsimul/visualization/interactive_gaze_plot.py +365 -0
  140. pyetsimul-3.2.1/pyetsimul/visualization/plot_config.py +200 -0
  141. pyetsimul-3.2.1/pyetsimul/visualization/setup_plots.py +421 -0
  142. pyetsimul-3.2.1/pyetsimul/visualization/transforms.py +43 -0
  143. pyetsimul-3.2.1/pyproject.toml +165 -0
  144. pyetsimul-3.2.1/resources/Funded_by_EU_Eyes4ICU.png +0 -0
  145. pyetsimul-3.2.1/unit_tests/__init__.py +1 -0
  146. pyetsimul-3.2.1/unit_tests/test_angle2gaze.py +54 -0
  147. pyetsimul-3.2.1/unit_tests/test_camera_pan_tilt.py +118 -0
  148. pyetsimul-3.2.1/unit_tests/test_camera_point_at.py +68 -0
  149. pyetsimul-3.2.1/unit_tests/test_camera_project.py +161 -0
  150. pyetsimul-3.2.1/unit_tests/test_camera_take_image.py +191 -0
  151. pyetsimul-3.2.1/unit_tests/test_camera_unproject.py +207 -0
  152. pyetsimul-3.2.1/unit_tests/test_eye_find_cr.py +107 -0
  153. pyetsimul-3.2.1/unit_tests/test_eye_find_cr_simple.py +88 -0
  154. pyetsimul-3.2.1/unit_tests/test_eye_find_refraction.py +79 -0
  155. pyetsimul-3.2.1/unit_tests/test_eye_get_pupil.py +293 -0
  156. pyetsimul-3.2.1/unit_tests/test_eye_get_pupil_image.py +219 -0
  157. pyetsimul-3.2.1/unit_tests/test_eye_look_at.py +78 -0
  158. pyetsimul-3.2.1/unit_tests/test_eye_point_within_cornea.py +105 -0
  159. pyetsimul-3.2.1/unit_tests/test_eye_pupil_size.py +68 -0
  160. pyetsimul-3.2.1/unit_tests/test_eye_refract_ray_dual_surface.py +88 -0
  161. pyetsimul-3.2.1/unit_tests/test_find_reflection_conic.py +72 -0
  162. pyetsimul-3.2.1/unit_tests/test_find_reflection_sphere.py +39 -0
  163. pyetsimul-3.2.1/unit_tests/test_find_refraction_conic.py +149 -0
  164. pyetsimul-3.2.1/unit_tests/test_find_refraction_sphere.py +158 -0
  165. pyetsimul-3.2.1/unit_tests/test_gaze2angle.py +104 -0
  166. pyetsimul-3.2.1/unit_tests/test_geometry_types_arithmetic.py +468 -0
  167. pyetsimul-3.2.1/unit_tests/test_glint_noise.py +108 -0
  168. pyetsimul-3.2.1/unit_tests/test_intersect_ray_circle.py +157 -0
  169. pyetsimul-3.2.1/unit_tests/test_intersect_ray_conic.py +70 -0
  170. pyetsimul-3.2.1/unit_tests/test_intersect_ray_plane.py +155 -0
  171. pyetsimul-3.2.1/unit_tests/test_intersect_ray_sphere.py +135 -0
  172. pyetsimul-3.2.1/unit_tests/test_line_intersect_2d.py +71 -0
  173. pyetsimul-3.2.1/unit_tests/test_lines_closest_point.py +103 -0
  174. pyetsimul-3.2.1/unit_tests/test_listings_law.py +94 -0
  175. pyetsimul-3.2.1/unit_tests/test_polynomial_validation.py +51 -0
  176. pyetsimul-3.2.1/unit_tests/test_reflect_ray_circle.py +129 -0
  177. pyetsimul-3.2.1/unit_tests/test_reflect_ray_conic.py +33 -0
  178. pyetsimul-3.2.1/unit_tests/test_reflect_ray_sphere.py +130 -0
  179. pyetsimul-3.2.1/unit_tests/test_refract_ray_conic.py +45 -0
  180. pyetsimul-3.2.1/unit_tests/test_refract_ray_sphere.py +103 -0
  181. pyetsimul-3.2.1/unit_tests/test_spherical_cornea_scaling.py +184 -0
  182. pyetsimul-3.2.1/uv.lock +2625 -0
  183. pyetsimul-3.2.1/validation_and_scientific_exploitation/__init__.py +4 -0
  184. pyetsimul-3.2.1/validation_and_scientific_exploitation/exploration_conic_vs_sphere.py +291 -0
  185. pyetsimul-3.2.1/validation_and_scientific_exploitation/exploration_pupil_size_decentration.py +262 -0
  186. pyetsimul-3.2.1/validation_and_scientific_exploitation/exploration_realistic_pupil.py +374 -0
  187. pyetsimul-3.2.1/validation_and_scientific_exploitation/exploration_screen_and_observer_test.py +161 -0
  188. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/demo_calibration.pdf +0 -0
  189. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/demo_calibration.png +0 -0
  190. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/demo_observer_test.pdf +0 -0
  191. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/demo_observer_test.png +0 -0
  192. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/demo_screen_test.pdf +0 -0
  193. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/demo_screen_test.png +0 -0
  194. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/results_conic_vs_sphere.txt +24 -0
  195. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/results_pupil_size_decentration.txt +19 -0
  196. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/results_realistic_pupil.txt +28 -0
  197. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/results_screen_observer_test.txt +16 -0
  198. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/validation_conic_cornea.pdf +0 -0
  199. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/validation_conic_cornea.png +0 -0
  200. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/validation_pupil_decentration.pdf +0 -0
  201. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/validation_pupil_decentration.png +0 -0
  202. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/validation_realistic_pupil.pdf +0 -0
  203. pyetsimul-3.2.1/validation_and_scientific_exploitation/output/validation_realistic_pupil.png +0 -0
  204. pyetsimul-3.2.1/validation_and_scientific_exploitation/validation_conic_cornea.py +302 -0
  205. pyetsimul-3.2.1/validation_and_scientific_exploitation/validation_pupil_decentration.py +307 -0
  206. pyetsimul-3.2.1/validation_and_scientific_exploitation/validation_realistic_pupil.py +598 -0
@@ -0,0 +1,33 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+ workflow_dispatch:
7
+
8
+ jobs:
9
+ deploy:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v4
13
+ with:
14
+ fetch-depth: 0 # Fetch all history for hatch-vcs to determine version from tags
15
+
16
+ - name: Set up Python
17
+ uses: actions/setup-python@v5
18
+ with:
19
+ python-version: '3.11'
20
+
21
+ - name: Install dependencies
22
+ run: |
23
+ python -m pip install --upgrade pip
24
+ pip install build twine
25
+
26
+ - name: Build package
27
+ run: python -m build
28
+
29
+ - name: Publish to PyPI
30
+ env:
31
+ TWINE_USERNAME: __token__
32
+ TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
33
+ run: twine upload dist/*
@@ -0,0 +1,215 @@
1
+ matlab/
2
+ paper
3
+ *.DS_Store
4
+
5
+ # Byte-compiled / optimized / DLL files
6
+ __pycache__/
7
+ *.py[codz]
8
+ *$py.class
9
+
10
+ # C extensions
11
+ *.so
12
+
13
+ # Distribution / packaging
14
+ .Python
15
+ build/
16
+ develop-eggs/
17
+ dist/
18
+ downloads/
19
+ eggs/
20
+ .eggs/
21
+ lib/
22
+ lib64/
23
+ parts/
24
+ sdist/
25
+ var/
26
+ wheels/
27
+ share/python-wheels/
28
+ *.egg-info/
29
+ .installed.cfg
30
+ *.egg
31
+ MANIFEST
32
+
33
+ # PyInstaller
34
+ # Usually these files are written by a python script from a template
35
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
36
+ *.manifest
37
+ *.spec
38
+
39
+ # Installer logs
40
+ pip-log.txt
41
+ pip-delete-this-directory.txt
42
+
43
+ # Unit test / coverage reports
44
+ htmlcov/
45
+ .tox/
46
+ .nox/
47
+ .coverage
48
+ .coverage.*
49
+ .cache
50
+ nosetests.xml
51
+ coverage.xml
52
+ *.cover
53
+ *.py.cover
54
+ .hypothesis/
55
+ .pytest_cache/
56
+ cover/
57
+
58
+ # Translations
59
+ *.mo
60
+ *.pot
61
+
62
+ # Django stuff:
63
+ *.log
64
+ local_settings.py
65
+ db.sqlite3
66
+ db.sqlite3-journal
67
+
68
+ # Flask stuff:
69
+ instance/
70
+ .webassets-cache
71
+
72
+ # Scrapy stuff:
73
+ .scrapy
74
+
75
+ # Sphinx documentation
76
+ docs/_build/
77
+
78
+ # PyBuilder
79
+ .pybuilder/
80
+ target/
81
+
82
+ # Jupyter Notebook
83
+ .ipynb_checkpoints
84
+
85
+ # IPython
86
+ profile_default/
87
+ ipython_config.py
88
+
89
+ # pyenv
90
+ # For a library or package, you might want to ignore these files since the code is
91
+ # intended to run in multiple environments; otherwise, check them in:
92
+ # .python-version
93
+
94
+ # pipenv
95
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
97
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
98
+ # install all needed dependencies.
99
+ #Pipfile.lock
100
+
101
+ # UV
102
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
103
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
104
+ # commonly ignored for libraries.
105
+ #uv.lock
106
+
107
+ # poetry
108
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
109
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
110
+ # commonly ignored for libraries.
111
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
112
+ #poetry.lock
113
+ #poetry.toml
114
+
115
+ # pdm
116
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
117
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
118
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
119
+ #pdm.lock
120
+ #pdm.toml
121
+ .pdm-python
122
+ .pdm-build/
123
+
124
+ # pixi
125
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
126
+ #pixi.lock
127
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
128
+ # in the .venv directory. It is recommended not to include this directory in version control.
129
+ .pixi
130
+
131
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
132
+ __pypackages__/
133
+
134
+ # Celery stuff
135
+ celerybeat-schedule
136
+ celerybeat.pid
137
+
138
+ # SageMath parsed files
139
+ *.sage.py
140
+
141
+ # Environments
142
+ .env
143
+ .envrc
144
+ .venv
145
+ env/
146
+ venv/
147
+ ENV/
148
+ env.bak/
149
+ venv.bak/
150
+
151
+ # Spyder project settings
152
+ .spyderproject
153
+ .spyproject
154
+
155
+ # Rope project settings
156
+ .ropeproject
157
+
158
+ # mkdocs documentation
159
+ /site
160
+
161
+ # mypy
162
+ .mypy_cache/
163
+ .dmypy.json
164
+ dmypy.json
165
+
166
+ # Pyre type checker
167
+ .pyre/
168
+
169
+ # pytype static type analyzer
170
+ .pytype/
171
+
172
+ # Cython debug symbols
173
+ cython_debug/
174
+
175
+ # PyCharm
176
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
177
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
178
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
179
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
180
+ #.idea/
181
+
182
+ # Abstra
183
+ # Abstra is an AI-powered process automation framework.
184
+ # Ignore directories containing user credentials, local state, and settings.
185
+ # Learn more at https://abstra.io/docs
186
+ .abstra/
187
+
188
+ # Visual Studio Code
189
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
190
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
191
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
192
+ # you could uncomment the following to ignore the entire vscode folder
193
+ .vscode/
194
+
195
+ # Ruff stuff:
196
+ .ruff_cache/
197
+
198
+ # PyPI configuration file
199
+ .pypirc
200
+
201
+ # Cursor
202
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
203
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
204
+ # refer to https://docs.cursor.com/context/ignore-files
205
+ .cursorignore
206
+ .cursorindexingignore
207
+
208
+ # Marimo
209
+ marimo/_static/
210
+ marimo/_lsp/
211
+ __marimo__/
212
+
213
+ # Generated figures and outputs
214
+ figures/
215
+ outputs/
@@ -0,0 +1,19 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-24.04
5
+ tools:
6
+ python: "3.13"
7
+ jobs:
8
+ pre_create_environment:
9
+ - asdf plugin add uv
10
+ - asdf install uv latest
11
+ - asdf global uv latest
12
+ create_environment:
13
+ - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
14
+ install:
15
+ - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
16
+
17
+ sphinx:
18
+ configuration: docs/conf.py
19
+ fail_on_warning: true