Add neutronics documentation and vault image

docs/modules/libra_toolbox.neutronics.rst

@@ -0,0 +1,29 @@
+libra\_toolbox.neutronics package
+=================================
+
+Submodules
+----------
+
+libra\_toolbox.neutronics.neutron\_source module
+------------------------------------------------
+
+.. automodule:: libra_toolbox.neutronics.neutron_source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libra\_toolbox.neutronics.vault module
+--------------------------------------
+
+.. automodule:: libra_toolbox.neutronics.vault
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: libra_toolbox.neutronics
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/libra_toolbox.rst

@@ -8,6 +8,7 @@ Subpackages
    :maxdepth: 4
 
    libra_toolbox.neutron_detection
+   libra_toolbox.neutronics
    libra_toolbox.tritium
 
 Module contents

libra_toolbox/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.dev162+g197f0c1.d20250314'
+__version_tuple__ = version_tuple = (0, 1, 'dev162', 'g197f0c1.d20250314')

libra_toolbox/neutronics/neutron_source.py

@@ -29,9 +29,9 @@ def A325_generator_diamond(
         by default (0, 0, 0)
     reference_uvw : tuple, optional
         direction for the polar angle (tuple or list of versors)
-    it is the same for the openmc.PolarAzimuthal class
-    more specifically, polar angle = 0 is the direction of the D accelerator
-    towards the Zr-T target, by default (0, 0, 1)
+        it is the same for the openmc.PolarAzimuthal class
+        more specifically, polar angle = 0 is the direction of the D accelerator
+        towards the Zr-T target, by default (0, 0, 1)
 
     Returns
     -------

libra_toolbox/neutronics/vault.py

@@ -9,6 +9,10 @@ def build_vault_model(
     """
     Builds a complete OpenMC model for a simulation setup representing a
     shielding system for MIT Vault Laboratory.
+
+    .. image:: ../../docs/_static/vault.png
+       :alt: Descriptive text for the image
+       :align: center
 
     Parameters:
     ----------
@@ -48,6 +52,8 @@ def build_vault_model(
       for neutrons using the `openmc_data_downloader` library.
     - If an `overall_exclusion_region` is provided, it will be incorporated
       to exclude specific parts of the geometry.
+    - The model's origin point (0.0, 0.0, 0.0) is located at the bottom right 
+      corner when entering the vault room.
     """
 
     # optional dependency