BornSim 0.9.0__tar.gz → 0.10.0__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 (171) hide show
  1. {bornsim-0.9.0 → bornsim-0.10.0}/.zenodo.json +2 -2
  2. {bornsim-0.9.0 → bornsim-0.10.0/BornSim.egg-info}/PKG-INFO +44 -24
  3. {bornsim-0.9.0 → bornsim-0.10.0}/BornSim.egg-info/SOURCES.txt +11 -1
  4. bornsim-0.10.0/BornSim.egg-info/requires.txt +21 -0
  5. {bornsim-0.9.0 → bornsim-0.10.0}/CITATION.cff +1 -1
  6. {bornsim-0.9.0/BornSim.egg-info → bornsim-0.10.0}/PKG-INFO +44 -24
  7. {bornsim-0.9.0 → bornsim-0.10.0}/README.rst +37 -12
  8. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/_version.py +1 -1
  9. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/angular_data.py +166 -30
  10. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/convergence.py +20 -3
  11. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/directions.py +54 -4
  12. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/ensemble.py +6 -3
  13. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/ensemble_sampling.py +24 -5
  14. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/geometry.py +145 -37
  15. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/green.py +8 -6
  16. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/grid.py +88 -12
  17. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/material.py +53 -7
  18. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/base.py +74 -5
  19. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/particles/core_shell.py +29 -4
  20. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/particles/cylinder.py +29 -4
  21. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/particles/ellipsoid.py +29 -4
  22. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/particles/spheres.py +73 -25
  23. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/random/fields.py +68 -15
  24. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/structured/composite.py +117 -11
  25. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/structured/periodic.py +45 -8
  26. bornsim-0.10.0/bornsim/plotting.py +493 -0
  27. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/polarization.py +2 -2
  28. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/results.py +230 -492
  29. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/rotation.py +39 -5
  30. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/sampling.py +14 -6
  31. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/series.py +6 -8
  32. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/solver.py +84 -23
  33. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/source.py +41 -27
  34. bornsim-0.10.0/bornsim/units.py +27 -0
  35. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/volume.py +130 -163
  36. {bornsim-0.9.0 → bornsim-0.10.0}/conda.recipe/meta.yaml +1 -1
  37. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/README.rst +8 -7
  38. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/born_interference.py +3 -5
  39. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/compare_orders.py +3 -5
  40. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/covariance_models.py +11 -8
  41. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/phase_function.py +16 -12
  42. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/random_medium.py +8 -15
  43. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/random_spheres.py +5 -4
  44. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/theory_random_fields.py +16 -12
  45. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/wavelength_dependence.py +11 -8
  46. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/result_plots.py +5 -7
  47. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/save_load_results.py +3 -5
  48. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/antenna_rods.py +6 -4
  49. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/dielectric_sphere.py +2 -5
  50. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/particle_families.py +11 -8
  51. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/periodic_array.py +11 -8
  52. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/structured_media.py +4 -8
  53. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/theory_directional_interference.py +15 -13
  54. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/angular_convergence.py +3 -5
  55. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/ensemble_sampling.py +3 -5
  56. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/finite_size_comparison.py +3 -5
  57. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/grid_refinement.py +2 -5
  58. bornsim-0.10.0/docs/images/branding-options/01-wave-b.png +0 -0
  59. bornsim-0.10.0/docs/images/branding-options/02-phase-lobe.png +0 -0
  60. bornsim-0.10.0/docs/images/branding-options/03-voxel-lens.png +0 -0
  61. bornsim-0.10.0/docs/images/branding-options/04-interference.png +0 -0
  62. bornsim-0.10.0/docs/images/branding-options/v2-01-dimensional-wave-b.png +0 -0
  63. bornsim-0.10.0/docs/images/branding-options/v2-02-refractive-volume.png +0 -0
  64. bornsim-0.10.0/docs/images/branding-options/v2-03-scattering-pearl.png +0 -0
  65. bornsim-0.10.0/docs/images/branding-options/v2-04-folded-interference.png +0 -0
  66. bornsim-0.10.0/docs/images/branding-prompts.rst +20 -0
  67. bornsim-0.10.0/docs/source/_static/favicon.png +0 -0
  68. bornsim-0.10.0/docs/source/_static/favicon.svg +3 -0
  69. bornsim-0.10.0/docs/source/_static/icon.png +0 -0
  70. bornsim-0.10.0/docs/source/_static/logo-dark.png +0 -0
  71. bornsim-0.10.0/docs/source/_static/logo.png +0 -0
  72. bornsim-0.10.0/docs/source/_static/logo.svg +3 -0
  73. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/conf.py +7 -4
  74. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/development.rst +3 -2
  75. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/examples.rst +7 -7
  76. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/getting_started.rst +8 -3
  77. bornsim-0.10.0/docs/source/medium_visualization.rst +158 -0
  78. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/reliability.rst +31 -0
  79. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/research.rst +2 -3
  80. {bornsim-0.9.0 → bornsim-0.10.0}/pyproject.toml +7 -7
  81. {bornsim-0.9.0 → bornsim-0.10.0}/tests/analytical/mie_reference.py +26 -2
  82. {bornsim-0.9.0 → bornsim-0.10.0}/tests/analytical/reference.py +3 -3
  83. bornsim-0.10.0/tests/analytical/test_nominal_spheres.py +156 -0
  84. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_api.py +14 -14
  85. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_configuration.py +2 -5
  86. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_geometry.py +8 -22
  87. bornsim-0.10.0/tests/numerical/test_plot_contract.py +123 -0
  88. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_random_spheres.py +2 -2
  89. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_unit_contract.py +6 -6
  90. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_units.py +2 -2
  91. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_volume_plotting.py +22 -87
  92. bornsim-0.9.0/BornSim.egg-info/requires.txt +0 -26
  93. bornsim-0.9.0/bornsim/units.py +0 -90
  94. bornsim-0.9.0/docs/images/branding-prompts.rst +0 -21
  95. bornsim-0.9.0/docs/source/_static/favicon.png +0 -0
  96. bornsim-0.9.0/docs/source/_static/favicon.svg +0 -4
  97. bornsim-0.9.0/docs/source/_static/icon.png +0 -0
  98. bornsim-0.9.0/docs/source/_static/logo.png +0 -0
  99. bornsim-0.9.0/docs/source/_static/logo.svg +0 -4
  100. bornsim-0.9.0/docs/source/medium_visualization.rst +0 -348
  101. bornsim-0.9.0/tests/numerical/test_plot_contract.py +0 -82
  102. bornsim-0.9.0/tests/packaging/test_release_tools.py +0 -157
  103. {bornsim-0.9.0 → bornsim-0.10.0}/.coveragerc +0 -0
  104. {bornsim-0.9.0 → bornsim-0.10.0}/.pre-commit-config.yaml +0 -0
  105. {bornsim-0.9.0 → bornsim-0.10.0}/BornSim.egg-info/dependency_links.txt +0 -0
  106. {bornsim-0.9.0 → bornsim-0.10.0}/BornSim.egg-info/top_level.txt +0 -0
  107. {bornsim-0.9.0 → bornsim-0.10.0}/CONTRIBUTING.md +0 -0
  108. {bornsim-0.9.0 → bornsim-0.10.0}/LICENSE +0 -0
  109. {bornsim-0.9.0 → bornsim-0.10.0}/MANIFEST.in +0 -0
  110. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/__init__.py +0 -0
  111. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/api.py +0 -0
  112. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/__init__.py +0 -0
  113. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/particles/__init__.py +0 -0
  114. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/random/__init__.py +0 -0
  115. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/random_medium.py +0 -0
  116. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/random_spheres.py +0 -0
  117. {bornsim-0.9.0 → bornsim-0.10.0}/bornsim/medium/structured/__init__.py +0 -0
  118. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/README.rst +0 -0
  119. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/absorbing_random_medium.py +0 -0
  120. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/contrast_sensitivity.py +0 -0
  121. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/coupled_spheres.py +0 -0
  122. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/born_orders/wavelength_corrections.py +0 -0
  123. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/random_media/README.rst +0 -0
  124. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/README.rst +0 -0
  125. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/angular_cut_and_full.py +0 -0
  126. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/coherent_diffuse.py +0 -0
  127. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/cross_section_and_volume.py +0 -0
  128. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/results/phase_normalization.py +0 -0
  129. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/README.rst +0 -0
  130. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/structured_media/illumination_polarization.py +0 -0
  131. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/README.rst +0 -0
  132. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/absorbing_sphere_balance.py +0 -0
  133. {bornsim-0.9.0 → bornsim-0.10.0}/docs/examples/validation/convergence_reports.py +0 -0
  134. {bornsim-0.9.0 → bornsim-0.10.0}/docs/images/bornsim_medium_opacity_3d.png +0 -0
  135. {bornsim-0.9.0 → bornsim-0.10.0}/docs/images/bornsim_spf_surface_3d.png +0 -0
  136. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/_static/phase_function.svg +0 -0
  137. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/absorption.rst +0 -0
  138. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/api.rst +0 -0
  139. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/gallery_config.py +0 -0
  140. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/guide.rst +0 -0
  141. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/index.rst +0 -0
  142. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/overview.rst +0 -0
  143. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/resources.rst +0 -0
  144. {bornsim-0.9.0 → bornsim-0.10.0}/docs/source/theory.rst +0 -0
  145. {bornsim-0.9.0 → bornsim-0.10.0}/makefile +0 -0
  146. {bornsim-0.9.0 → bornsim-0.10.0}/pytest.ini +0 -0
  147. {bornsim-0.9.0 → bornsim-0.10.0}/setup.cfg +0 -0
  148. {bornsim-0.9.0 → bornsim-0.10.0}/tests/analytical/test_absorbing_mie.py +0 -0
  149. {bornsim-0.9.0 → bornsim-0.10.0}/tests/analytical/test_model.py +0 -0
  150. {bornsim-0.9.0 → bornsim-0.10.0}/tests/analytical/test_numerical_reference.py +0 -0
  151. {bornsim-0.9.0 → bornsim-0.10.0}/tests/conftest.py +0 -0
  152. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_absorption.py +0 -0
  153. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_api_keywords.py +0 -0
  154. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_api_ownership.py +0 -0
  155. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_api_scope.py +0 -0
  156. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_directional_api.py +0 -0
  157. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_directions.py +0 -0
  158. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_engine.py +0 -0
  159. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_explicit_physics.py +0 -0
  160. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_illumination.py +0 -0
  161. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_media.py +0 -0
  162. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_medium_composition.py +0 -0
  163. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_medium_families.py +0 -0
  164. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_medium_metadata.py +0 -0
  165. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_polarization.py +0 -0
  166. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_reliability.py +0 -0
  167. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_result.py +0 -0
  168. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_result_contract.py +0 -0
  169. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_rotation.py +0 -0
  170. {bornsim-0.9.0 → bornsim-0.10.0}/tests/numerical/test_series.py +0 -0
  171. {bornsim-0.9.0 → bornsim-0.10.0}/tools/check_wheel.py +0 -0
@@ -8,11 +8,11 @@
8
8
  }
9
9
  ],
10
10
  "license": "mit",
11
- "version": "0.9.0",
11
+ "version": "0.10.0",
12
12
  "keywords": [
13
13
  "Born approximation",
14
14
  "light scattering",
15
15
  "random media"
16
16
  ],
17
- "publication_date": "2026-10-25"
17
+ "publication_date": "2026-11-16"
18
18
  }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: BornSim
3
- Version: 0.9.0
3
+ Version: 0.10.0
4
4
  Summary: Vector Born-series scattering from continuous random dielectric media
5
5
  Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
6
6
  License-Expression: MIT
@@ -19,26 +19,21 @@ Requires-Python: >=3.11
19
19
  Description-Content-Type: text/x-rst
20
20
  License-File: LICENSE
21
21
  Requires-Dist: numpy<3,>=1.24
22
- Requires-Dist: TypedUnit>=0.2.9
22
+ Requires-Dist: TypedUnit>=0.6.0
23
23
  Requires-Dist: pint<0.26,>=0.24
24
24
  Requires-Dist: matplotlib<4,>=3.7
25
25
  Requires-Dist: plotly<7,>=6
26
26
  Provides-Extra: release
27
- Requires-Dist: martinpdes-maintenance==0.2.2; extra == "release"
27
+ Requires-Dist: martinpdes-maintenance==0.2.3; extra == "release"
28
28
  Provides-Extra: testing
29
- Requires-Dist: martinpdes-maintenance==0.2.2; extra == "testing"
30
- Requires-Dist: pytest<10,>=8; extra == "testing"
31
- Requires-Dist: pytest-cov<8,>=5; extra == "testing"
29
+ Requires-Dist: martinpdes-maintenance[testing]==0.2.3; extra == "testing"
30
+ Requires-Dist: pytest-cov<8; extra == "testing"
32
31
  Provides-Extra: test
33
32
  Requires-Dist: BornSim[testing]; extra == "test"
34
33
  Provides-Extra: documentation
35
- Requires-Dist: MartinPdeS-docs<0.3,>=0.2.5; extra == "documentation"
34
+ Requires-Dist: MartinPdeS-docs<0.5,>=0.4.0; extra == "documentation"
36
35
  Provides-Extra: dev
37
- Requires-Dist: ruff<1,>=0.11; extra == "dev"
38
- Requires-Dist: mypy<2,>=1.11; extra == "dev"
39
- Requires-Dist: build<2,>=1.2; extra == "dev"
40
- Requires-Dist: twine<7,>=6; extra == "dev"
41
- Requires-Dist: pre-commit<5,>=4; extra == "dev"
36
+ Requires-Dist: martinpdes-maintenance[dev,quality]==0.2.3; extra == "dev"
42
37
  Dynamic: license-file
43
38
 
44
39
  .. image:: docs/source/_static/logo.png
@@ -103,42 +98,67 @@ Quick start
103
98
  from bornsim.medium.random_medium import GaussianMedium
104
99
  from bornsim.units import ureg
105
100
 
106
- grid = Grid(shape=(16, 16, 16), spacing=50 * ureg.nanometer)
101
+ grid = Grid(
102
+ shape=(16, 16, 16),
103
+ spacing=50 * ureg.nanometer,
104
+ )
105
+
107
106
  medium = GaussianMedium(
108
107
  background_refractive_index=1.33,
109
108
  refractive_index_std=0.01,
110
109
  correlation_length=100 * ureg.nanometer,
111
110
  )
112
111
 
112
+ source = Source(wavelength=633 * ureg.nanometer)
113
+
113
114
  solver = Solver(
114
- source=Source(wavelength=633 * ureg.nanometer),
115
+ source=source,
115
116
  order=3,
116
117
  )
117
118
 
119
+ ensemble_sampling = EnsembleSampling(
120
+ realizations=4,
121
+ seed=42,
122
+ )
123
+
118
124
  result = solver.ensemble(
119
125
  medium=medium,
120
126
  grid=grid,
121
- ensemble_sampling=EnsembleSampling(realizations=4, seed=42),
127
+ ensemble_sampling=ensemble_sampling,
122
128
  )
123
129
 
124
- print(result.mu_s.to("1 / millimeter"))
125
- print(result.g)
126
- print(result.mu_s_prime.to("1 / millimeter"))
130
+ print(f"mu_s = {result.mu_s.to('1 / millimeter')}")
131
+
132
+ print(f"g = {result.g}")
133
+
134
+ print(f"mu_s_prime = {result.mu_s_prime.to('1 / millimeter')}")
135
+
127
136
  result.plot()
128
137
 
129
138
  For one fixed structured sample, use ``solver.solve(target=volume)``. The
130
- result can also be visualized directly:
139
+ result can also be visualized directly with Plotly:
131
140
 
132
141
  .. code-block:: python
133
142
 
134
- volume = medium.to_volume(grid=grid, seed=42)
143
+ volume = medium.to_volume(
144
+ grid=grid,
145
+ seed=42,
146
+ )
147
+
135
148
  medium_figure = volume.plot_3d(
136
149
  field="refractive_index",
137
- opacity_scale="increasing",
138
150
  )
139
- phase_figure = solver.solve(target=volume).plot_phase_function(view="3d")
140
- medium_figure.write_html("medium.html", include_plotlyjs=True)
141
- phase_figure.write_html("phase_function.html", include_plotlyjs=True)
151
+
152
+ result = solver.solve(target=volume)
153
+
154
+ phase_figure = result.plot_phase_function(view="3d")
155
+
156
+ medium_figure.show()
157
+
158
+ phase_figure.show()
159
+
160
+ All 3D views use Plotly exclusively. Two-dimensional plots use Matplotlib.
161
+ Plotly figures support ``figure.show()`` and offline ``figure.write_html()`` exports.
142
162
 
143
163
  What BornSim models
144
164
  -------------------
@@ -26,6 +26,7 @@ bornsim/geometry.py
26
26
  bornsim/green.py
27
27
  bornsim/grid.py
28
28
  bornsim/material.py
29
+ bornsim/plotting.py
29
30
  bornsim/polarization.py
30
31
  bornsim/results.py
31
32
  bornsim/rotation.py
@@ -90,6 +91,14 @@ docs/examples/validation/grid_refinement.py
90
91
  docs/images/bornsim_medium_opacity_3d.png
91
92
  docs/images/bornsim_spf_surface_3d.png
92
93
  docs/images/branding-prompts.rst
94
+ docs/images/branding-options/01-wave-b.png
95
+ docs/images/branding-options/02-phase-lobe.png
96
+ docs/images/branding-options/03-voxel-lens.png
97
+ docs/images/branding-options/04-interference.png
98
+ docs/images/branding-options/v2-01-dimensional-wave-b.png
99
+ docs/images/branding-options/v2-02-refractive-volume.png
100
+ docs/images/branding-options/v2-03-scattering-pearl.png
101
+ docs/images/branding-options/v2-04-folded-interference.png
93
102
  docs/source/absorption.rst
94
103
  docs/source/api.rst
95
104
  docs/source/conf.py
@@ -108,6 +117,7 @@ docs/source/theory.rst
108
117
  docs/source/_static/favicon.png
109
118
  docs/source/_static/favicon.svg
110
119
  docs/source/_static/icon.png
120
+ docs/source/_static/logo-dark.png
111
121
  docs/source/_static/logo.png
112
122
  docs/source/_static/logo.svg
113
123
  docs/source/_static/phase_function.svg
@@ -116,6 +126,7 @@ tests/analytical/mie_reference.py
116
126
  tests/analytical/reference.py
117
127
  tests/analytical/test_absorbing_mie.py
118
128
  tests/analytical/test_model.py
129
+ tests/analytical/test_nominal_spheres.py
119
130
  tests/analytical/test_numerical_reference.py
120
131
  tests/numerical/test_absorption.py
121
132
  tests/numerical/test_api.py
@@ -144,5 +155,4 @@ tests/numerical/test_series.py
144
155
  tests/numerical/test_unit_contract.py
145
156
  tests/numerical/test_units.py
146
157
  tests/numerical/test_volume_plotting.py
147
- tests/packaging/test_release_tools.py
148
158
  tools/check_wheel.py
@@ -0,0 +1,21 @@
1
+ numpy<3,>=1.24
2
+ TypedUnit>=0.6.0
3
+ pint<0.26,>=0.24
4
+ matplotlib<4,>=3.7
5
+ plotly<7,>=6
6
+
7
+ [dev]
8
+ martinpdes-maintenance[dev,quality]==0.2.3
9
+
10
+ [documentation]
11
+ MartinPdeS-docs<0.5,>=0.4.0
12
+
13
+ [release]
14
+ martinpdes-maintenance==0.2.3
15
+
16
+ [test]
17
+ BornSim[testing]
18
+
19
+ [testing]
20
+ martinpdes-maintenance[testing]==0.2.3
21
+ pytest-cov<8
@@ -2,7 +2,7 @@ cff-version: 1.2.0
2
2
  message: "If you use BornSim in research, please cite the software version used."
3
3
  title: "BornSim"
4
4
  type: software
5
- version: "0.9.0"
5
+ version: "0.10.0"
6
6
  authors:
7
7
  - family-names: "Poinsinet de Sivry-Houle"
8
8
  given-names: "Martin"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: BornSim
3
- Version: 0.9.0
3
+ Version: 0.10.0
4
4
  Summary: Vector Born-series scattering from continuous random dielectric media
5
5
  Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
6
6
  License-Expression: MIT
@@ -19,26 +19,21 @@ Requires-Python: >=3.11
19
19
  Description-Content-Type: text/x-rst
20
20
  License-File: LICENSE
21
21
  Requires-Dist: numpy<3,>=1.24
22
- Requires-Dist: TypedUnit>=0.2.9
22
+ Requires-Dist: TypedUnit>=0.6.0
23
23
  Requires-Dist: pint<0.26,>=0.24
24
24
  Requires-Dist: matplotlib<4,>=3.7
25
25
  Requires-Dist: plotly<7,>=6
26
26
  Provides-Extra: release
27
- Requires-Dist: martinpdes-maintenance==0.2.2; extra == "release"
27
+ Requires-Dist: martinpdes-maintenance==0.2.3; extra == "release"
28
28
  Provides-Extra: testing
29
- Requires-Dist: martinpdes-maintenance==0.2.2; extra == "testing"
30
- Requires-Dist: pytest<10,>=8; extra == "testing"
31
- Requires-Dist: pytest-cov<8,>=5; extra == "testing"
29
+ Requires-Dist: martinpdes-maintenance[testing]==0.2.3; extra == "testing"
30
+ Requires-Dist: pytest-cov<8; extra == "testing"
32
31
  Provides-Extra: test
33
32
  Requires-Dist: BornSim[testing]; extra == "test"
34
33
  Provides-Extra: documentation
35
- Requires-Dist: MartinPdeS-docs<0.3,>=0.2.5; extra == "documentation"
34
+ Requires-Dist: MartinPdeS-docs<0.5,>=0.4.0; extra == "documentation"
36
35
  Provides-Extra: dev
37
- Requires-Dist: ruff<1,>=0.11; extra == "dev"
38
- Requires-Dist: mypy<2,>=1.11; extra == "dev"
39
- Requires-Dist: build<2,>=1.2; extra == "dev"
40
- Requires-Dist: twine<7,>=6; extra == "dev"
41
- Requires-Dist: pre-commit<5,>=4; extra == "dev"
36
+ Requires-Dist: martinpdes-maintenance[dev,quality]==0.2.3; extra == "dev"
42
37
  Dynamic: license-file
43
38
 
44
39
  .. image:: docs/source/_static/logo.png
@@ -103,42 +98,67 @@ Quick start
103
98
  from bornsim.medium.random_medium import GaussianMedium
104
99
  from bornsim.units import ureg
105
100
 
106
- grid = Grid(shape=(16, 16, 16), spacing=50 * ureg.nanometer)
101
+ grid = Grid(
102
+ shape=(16, 16, 16),
103
+ spacing=50 * ureg.nanometer,
104
+ )
105
+
107
106
  medium = GaussianMedium(
108
107
  background_refractive_index=1.33,
109
108
  refractive_index_std=0.01,
110
109
  correlation_length=100 * ureg.nanometer,
111
110
  )
112
111
 
112
+ source = Source(wavelength=633 * ureg.nanometer)
113
+
113
114
  solver = Solver(
114
- source=Source(wavelength=633 * ureg.nanometer),
115
+ source=source,
115
116
  order=3,
116
117
  )
117
118
 
119
+ ensemble_sampling = EnsembleSampling(
120
+ realizations=4,
121
+ seed=42,
122
+ )
123
+
118
124
  result = solver.ensemble(
119
125
  medium=medium,
120
126
  grid=grid,
121
- ensemble_sampling=EnsembleSampling(realizations=4, seed=42),
127
+ ensemble_sampling=ensemble_sampling,
122
128
  )
123
129
 
124
- print(result.mu_s.to("1 / millimeter"))
125
- print(result.g)
126
- print(result.mu_s_prime.to("1 / millimeter"))
130
+ print(f"mu_s = {result.mu_s.to('1 / millimeter')}")
131
+
132
+ print(f"g = {result.g}")
133
+
134
+ print(f"mu_s_prime = {result.mu_s_prime.to('1 / millimeter')}")
135
+
127
136
  result.plot()
128
137
 
129
138
  For one fixed structured sample, use ``solver.solve(target=volume)``. The
130
- result can also be visualized directly:
139
+ result can also be visualized directly with Plotly:
131
140
 
132
141
  .. code-block:: python
133
142
 
134
- volume = medium.to_volume(grid=grid, seed=42)
143
+ volume = medium.to_volume(
144
+ grid=grid,
145
+ seed=42,
146
+ )
147
+
135
148
  medium_figure = volume.plot_3d(
136
149
  field="refractive_index",
137
- opacity_scale="increasing",
138
150
  )
139
- phase_figure = solver.solve(target=volume).plot_phase_function(view="3d")
140
- medium_figure.write_html("medium.html", include_plotlyjs=True)
141
- phase_figure.write_html("phase_function.html", include_plotlyjs=True)
151
+
152
+ result = solver.solve(target=volume)
153
+
154
+ phase_figure = result.plot_phase_function(view="3d")
155
+
156
+ medium_figure.show()
157
+
158
+ phase_figure.show()
159
+
160
+ All 3D views use Plotly exclusively. Two-dimensional plots use Matplotlib.
161
+ Plotly figures support ``figure.show()`` and offline ``figure.write_html()`` exports.
142
162
 
143
163
  What BornSim models
144
164
  -------------------
@@ -60,42 +60,67 @@ Quick start
60
60
  from bornsim.medium.random_medium import GaussianMedium
61
61
  from bornsim.units import ureg
62
62
 
63
- grid = Grid(shape=(16, 16, 16), spacing=50 * ureg.nanometer)
63
+ grid = Grid(
64
+ shape=(16, 16, 16),
65
+ spacing=50 * ureg.nanometer,
66
+ )
67
+
64
68
  medium = GaussianMedium(
65
69
  background_refractive_index=1.33,
66
70
  refractive_index_std=0.01,
67
71
  correlation_length=100 * ureg.nanometer,
68
72
  )
69
73
 
74
+ source = Source(wavelength=633 * ureg.nanometer)
75
+
70
76
  solver = Solver(
71
- source=Source(wavelength=633 * ureg.nanometer),
77
+ source=source,
72
78
  order=3,
73
79
  )
74
80
 
81
+ ensemble_sampling = EnsembleSampling(
82
+ realizations=4,
83
+ seed=42,
84
+ )
85
+
75
86
  result = solver.ensemble(
76
87
  medium=medium,
77
88
  grid=grid,
78
- ensemble_sampling=EnsembleSampling(realizations=4, seed=42),
89
+ ensemble_sampling=ensemble_sampling,
79
90
  )
80
91
 
81
- print(result.mu_s.to("1 / millimeter"))
82
- print(result.g)
83
- print(result.mu_s_prime.to("1 / millimeter"))
92
+ print(f"mu_s = {result.mu_s.to('1 / millimeter')}")
93
+
94
+ print(f"g = {result.g}")
95
+
96
+ print(f"mu_s_prime = {result.mu_s_prime.to('1 / millimeter')}")
97
+
84
98
  result.plot()
85
99
 
86
100
  For one fixed structured sample, use ``solver.solve(target=volume)``. The
87
- result can also be visualized directly:
101
+ result can also be visualized directly with Plotly:
88
102
 
89
103
  .. code-block:: python
90
104
 
91
- volume = medium.to_volume(grid=grid, seed=42)
105
+ volume = medium.to_volume(
106
+ grid=grid,
107
+ seed=42,
108
+ )
109
+
92
110
  medium_figure = volume.plot_3d(
93
111
  field="refractive_index",
94
- opacity_scale="increasing",
95
112
  )
96
- phase_figure = solver.solve(target=volume).plot_phase_function(view="3d")
97
- medium_figure.write_html("medium.html", include_plotlyjs=True)
98
- phase_figure.write_html("phase_function.html", include_plotlyjs=True)
113
+
114
+ result = solver.solve(target=volume)
115
+
116
+ phase_figure = result.plot_phase_function(view="3d")
117
+
118
+ medium_figure.show()
119
+
120
+ phase_figure.show()
121
+
122
+ All 3D views use Plotly exclusively. Two-dimensional plots use Matplotlib.
123
+ Plotly figures support ``figure.show()`` and offline ``figure.write_html()`` exports.
99
124
 
100
125
  What BornSim models
101
126
  -------------------
@@ -1,5 +1,5 @@
1
1
  """Release version maintained by martinpdes-maintenance."""
2
2
 
3
- __version__ = version = "0.9.0"
3
+ __version__ = version = "0.10.0"
4
4
  __version_tuple__ = version_tuple = tuple(int(part) for part in version.split("."))
5
5
  __commit_id__ = commit_id = None