simba-accelerator 0.1.3__tar.gz → 0.2.0__tar.gz

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/MANIFEST.in

@@ -1,5 +1,3 @@
-include versioneer.py
-include simba/_version.py
 include simba/Executables.yaml
 prune simba/Support_Files
 recursive-include simba *.yaml

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simba-accelerator
-Version: 0.1.3
+Version: 0.2.0
 Summary: A python framework for particle accelerator simulations
 Author-email: James Jones <james.jones@stfc.ac.uk>
 Maintainer-email: James Jones <james.jones@stfc.ac.uk>, Alex Brynes <alexander.brynes@stfc.ac.uk>, Mark Johnson <mark.johnson@stfc.ac.uk>
@@ -11,7 +11,7 @@ Project-URL: Issues, https://github.com/astec-stfc/simba/-/issues/
 Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: deepdiff>=5
+Requires-Dist: deepdiff>=8.6
 Requires-Dist: h5py>=2.10
 Requires-Dist: munch>=2.5
 Requires-Dist: numpy>=2
@@ -38,17 +38,15 @@ Requires-Dist: cheetah-accelerator>=0.7.5
 Requires-Dist: openpmd-beamphysics>=0.10
 Requires-Dist: xopt
 Requires-Dist: Wake-T>=0.8.0
-Requires-Dist: nala-accelerator
+Requires-Dist: laura-accelerator
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: MasterLattice; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx>=8; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Requires-Dist: myst-nb; extra == "docs"
 Requires-Dist: sphinx_autodoc_typehints>=3; extra == "docs"
-Requires-Dist: MasterLattice; extra == "docs"
 Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Dynamic: requires-python
 
@@ -61,7 +59,7 @@ Dynamic: requires-python
 Our mission statement is *"To create a start to end framework for consistent, transparent simulations of particle 
 accelerators and FELs that anybody can use, and that everybody trusts."*
 
-By leveraging a [standard accelerator lattice format](https://github.com/astec-stfc/nala.git), `SIMBA` 
+By leveraging a [standard accelerator lattice format](https://github.com/astec-stfc/laura.git), `SIMBA` 
 is able to generate and run input files for a range of accelerator simulation codes, enabling seamless transfer 
 of input and output distributions. 
 
@@ -98,12 +96,21 @@ The package and its dependencies can be installed using the following command in
 ```bash
 pip install .
 ```
+
+Install from PyPI
+-----------------
+
+Alternatively, `SIMBA` can be installed directly from PyPI using:
+
+```bash
+pip install simba-accelerator
+```
     
 Optional Dependencies
 ---------------------
 
 In order to access the accelerator code executables, they must also inform ``SIMBA`` of their
-locations. See the entry on [SimCodes](https://simba.readthedocs.io/en/latest/SimCodes.html).
+locations. See the entry on [SimCodes](https://simba-accelerator.readthedocs.io/en/latest/SimCodes.html).
 
 Participation
 -------------
@@ -121,9 +128,9 @@ We are also happy to help with installation and setting up your accelerator latt
 Getting started with SIMBA
 -----------------------------
 
-Accelerator lattices in :mod:`SIMBA` are derived from the `NALA <https://github.com/astec-stfc/nala/>`_
+Accelerator lattices in `SIMBA` are derived from the [LAURA](https://github.com/astec-stfc/laura/)
 standard lattice format. This is a schema for providing generic descriptions of accelerator elements and
-layouts **TODO add hyperlinks to NALA doc page once it exists**.
+layouts; see [LAURA documentation](https://laura-accelerator.readthedocs.io/en/latest/).
 
 Given that this format is designed to capture all relevant information about accelerator elements,
 and that it includes a built-in translator module for exporting lattice files to various simulation codes,
@@ -168,20 +175,21 @@ groups:
   bunch_compressor:
     type: chicane
     elements: [CLA-VBC-MAG-DIP-01, CLA-VBC-MAG-DIP-02, CLA-VBC-MAG-DIP-03, CLA-VBC-MAG-DIP-04]
-layout: /path/to/nala-lattices/CLARA/layouts.yaml
-section: /path/to/nala-lattices/CLARA/sections.yaml
-element_list: /path/to/nala-lattices/CLARA/YAML/
+layout: /path/to/laura-lattices/CLARA/layouts.yaml
+section: /path/to/laura-lattices/CLARA/sections.yaml
+element_list: /path/to/laura-lattices/CLARA/YAML/
 
 ```
 
 This lattice definition would produce several output files (called ``injector400.in``, ``Linac.lte``,
 and ``FEBE.py``) for running in the **ASTRA**, **Elegant** and **Ocelot** beam tracking codes.
 
-The elements are loaded from the directory ``/path/to/nala-lattices/CLARA/YAML/`` defined above.
+The elements are loaded from the directory ``/path/to/laura-lattices/CLARA/YAML/`` defined above.
 
 As this simulation starts from the cathode, the ``input`` definition is required for the first
 `injector400` ``file`` block. An alternative method for starting is to specify ``input/particle_definition`` to
-point to an existing beam file **#TODO add reference to beams page**.
+point to an existing 
+[beam file](https://simba-accelerator.readthedocs.io/en/latest/examples/notebooks/beams_example.html).
 
 For `follow-on` lattice runs, it is sufficient to define the ``output: start_element``, which should match the 
 ``output: end_element`` definition from the previous ``file`` block.
@@ -199,9 +207,9 @@ import simba.Framework as fw
 #       "verbose" will print a progressbar if true
 simcodes_location = "/path/to/simcodes/directory"
 framework = fw.Framework(
-    master_lattice="/path/to/nala-lattices/CLARA",
+    master_lattice="/path/to/laura-lattices/CLARA",
     directory="./example",
-    generator_defaults="/path/to/nala-lattices/CLARA/Generators/clara.yaml",
+    generator_defaults="/path/to/laura-lattices/CLARA/Generators/clara.yaml",
     simcodes_location=simcodes_location,
     clean=True,
     verbose=True,

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/README.md

@@ -7,7 +7,7 @@
 Our mission statement is *"To create a start to end framework for consistent, transparent simulations of particle 
 accelerators and FELs that anybody can use, and that everybody trusts."*
 
-By leveraging a [standard accelerator lattice format](https://github.com/astec-stfc/nala.git), `SIMBA` 
+By leveraging a [standard accelerator lattice format](https://github.com/astec-stfc/laura.git), `SIMBA` 
 is able to generate and run input files for a range of accelerator simulation codes, enabling seamless transfer 
 of input and output distributions. 
 
@@ -44,12 +44,21 @@ The package and its dependencies can be installed using the following command in
 ```bash
 pip install .
 ```
+
+Install from PyPI
+-----------------
+
+Alternatively, `SIMBA` can be installed directly from PyPI using:
+
+```bash
+pip install simba-accelerator
+```
     
 Optional Dependencies
 ---------------------
 
 In order to access the accelerator code executables, they must also inform ``SIMBA`` of their
-locations. See the entry on [SimCodes](https://simba.readthedocs.io/en/latest/SimCodes.html).
+locations. See the entry on [SimCodes](https://simba-accelerator.readthedocs.io/en/latest/SimCodes.html).
 
 Participation
 -------------
@@ -67,9 +76,9 @@ We are also happy to help with installation and setting up your accelerator latt
 Getting started with SIMBA
 -----------------------------
 
-Accelerator lattices in :mod:`SIMBA` are derived from the `NALA <https://github.com/astec-stfc/nala/>`_
+Accelerator lattices in `SIMBA` are derived from the [LAURA](https://github.com/astec-stfc/laura/)
 standard lattice format. This is a schema for providing generic descriptions of accelerator elements and
-layouts **TODO add hyperlinks to NALA doc page once it exists**.
+layouts; see [LAURA documentation](https://laura-accelerator.readthedocs.io/en/latest/).
 
 Given that this format is designed to capture all relevant information about accelerator elements,
 and that it includes a built-in translator module for exporting lattice files to various simulation codes,
@@ -114,20 +123,21 @@ groups:
   bunch_compressor:
     type: chicane
     elements: [CLA-VBC-MAG-DIP-01, CLA-VBC-MAG-DIP-02, CLA-VBC-MAG-DIP-03, CLA-VBC-MAG-DIP-04]
-layout: /path/to/nala-lattices/CLARA/layouts.yaml
-section: /path/to/nala-lattices/CLARA/sections.yaml
-element_list: /path/to/nala-lattices/CLARA/YAML/
+layout: /path/to/laura-lattices/CLARA/layouts.yaml
+section: /path/to/laura-lattices/CLARA/sections.yaml
+element_list: /path/to/laura-lattices/CLARA/YAML/
 
 ```
 
 This lattice definition would produce several output files (called ``injector400.in``, ``Linac.lte``,
 and ``FEBE.py``) for running in the **ASTRA**, **Elegant** and **Ocelot** beam tracking codes.
 
-The elements are loaded from the directory ``/path/to/nala-lattices/CLARA/YAML/`` defined above.
+The elements are loaded from the directory ``/path/to/laura-lattices/CLARA/YAML/`` defined above.
 
 As this simulation starts from the cathode, the ``input`` definition is required for the first
 `injector400` ``file`` block. An alternative method for starting is to specify ``input/particle_definition`` to
-point to an existing beam file **#TODO add reference to beams page**.
+point to an existing 
+[beam file](https://simba-accelerator.readthedocs.io/en/latest/examples/notebooks/beams_example.html).
 
 For `follow-on` lattice runs, it is sufficient to define the ``output: start_element``, which should match the 
 ``output: end_element`` definition from the previous ``file`` block.
@@ -145,9 +155,9 @@ import simba.Framework as fw
 #       "verbose" will print a progressbar if true
 simcodes_location = "/path/to/simcodes/directory"
 framework = fw.Framework(
-    master_lattice="/path/to/nala-lattices/CLARA",
+    master_lattice="/path/to/laura-lattices/CLARA",
     directory="./example",
-    generator_defaults="/path/to/nala-lattices/CLARA/Generators/clara.yaml",
+    generator_defaults="/path/to/laura-lattices/CLARA/Generators/clara.yaml",
     simcodes_location=simcodes_location,
     clean=True,
     verbose=True,

simba_accelerator-0.2.0/docs/source/Framework.rst

@@ -0,0 +1,10 @@
+Framework
+---------
+
+.. automodule:: simba.Framework
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    
+.. toctree::
+   :maxdepth: 2

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/SimCodes.rst

@@ -30,7 +30,7 @@ Creating a SimCodes Directory
 -----------------------------
 
 One can create a top-level directory containing sub-folders for each tracking code, and instantiate :mod:`SIMBA`
-with a ``simcodes_location`` argument:
+with a ``simcodes`` argument:
 
 .. code-block:: python
 
@@ -40,7 +40,7 @@ with a ``simcodes_location`` argument:
 
     fw = Framework(
         directory=directory,
-        simcodes_location=simcodes_location,
+        simcodes=simcodes_location,
     )
 
 Alternatively, one can set up :mod:`SIMBA` without this argument and set up the ``SimCodes`` location afterwards:

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/examples/notebooks/beams_example.ipynb

@@ -44,8 +44,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import sys\n",
-    "sys.path.append('/home/xkc85723/Documents/simba')\n",
     "import simba.Modules.Beams as rbf  # noqa E402\n",
     "from simba.Modules.Beams.plot import (\n",
     "    plotScreenImage,\n",

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/examples/notebooks/getting_started.ipynb

@@ -13,9 +13,9 @@
    "id": "1fd06310-63aa-4f50-b67f-d63893108de5",
    "metadata": {},
    "source": [
-    "This notebook will show how to set up `SIMBA`, load in a `NALA` object and settings for tracking, and show how to plot the results.\n",
+    "This notebook will show how to set up `SIMBA`, load in a `LAURA` object and settings for tracking, and show how to plot the results.\n",
     "\n",
-    "It is assumed that a `NALA` lattice directory and a `SimCodes` directory have been prepared and set with environment variables (see the docs [here](https://simba-accelerator.readthedocs.io/en/latest/SimCodes.html)). "
+    "It is assumed that a `LAURA` lattice directory and a `SimCodes` directory have been prepared and set with environment variables (see the docs [here](https://simba-accelerator.readthedocs.io/en/latest/SimCodes.html)). "
    ]
   },
   {

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/examples/notebooks/utility_functions.ipynb

@@ -99,7 +99,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "{'beam': {'filename': None, 'code': None}, 'GPTLICENSE': '', 'delete_tracking_files': False, 'astra_use_wsl': 1, 'master_subdir': '/home/xkc85723/Documents/simba/docs/source/examples/notebooks/getting_started', 'master_lattice_location': '/home/xkc85723/Documents/nala-lattices/CLARA/./', 'simcodes_location': '/home/xkc85723/Documents/venv/lib/python3.12/site-packages/SimCodes/'}\n"
+      "{'beam': {'filename': None, 'code': None}, 'GPTLICENSE': '', 'delete_tracking_files': False, 'astra_use_wsl': 1, 'master_subdir': '/home/xkc85723/Documents/simba/docs/source/examples/notebooks/getting_started', 'master_lattice': '/home/xkc85723/Documents/laura-lattices/CLARA/./', 'simcodes_location': '/home/xkc85723/Documents/venv/lib/python3.12/site-packages/SimCodes/'}\n"
      ]
     }
    ],
@@ -127,7 +127,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "FrameworkSettings({'settingsFilename': '/home/xkc85723/Documents/nala-lattices/CLARA/./Lattices/clara400_v13_combined.def', 'global': {}, 'generator': {'code': 'astra', 'default': 'clara_400_3ps'}, 'section': '/home/xkc85723/Documents/nala-lattices/CLARA/sections.yaml', 'element_list': '/home/xkc85723/Documents/nala-lattices/CLARA/YAML/', 'groups': {'bunch_compressor': {'type': 'chicane', 'elements': ['CLA-VBC-MAG-DIP-01', 'CLA-VBC-MAG-DIP-02', 'CLA-VBC-MAG-DIP-03', 'CLA-VBC-MAG-DIP-04']}}, 'elements': {}, 'files': {'injector400': {'code': 'astra', 'charge': {'cathode': True, 'space_charge_mode': '2D', 'mirror_charge': True}, 'input': {'particle_definition': 'initial_distribution'}, 'output': {'zstart': 0, 'end_element': 'CLA-S02-SIM-APER-01'}}, 'Linac': {'code': 'elegant', 'output': {'start_element': 'CLA-S02-SIM-APER-01', 'end_element': 'CLA-FEA-SIM-START-01'}}, 'FEBE': {'code': 'elegant', 'charge': {'cathode': False, 'space_charge_mode': '3D'}, 'input': {}, 'output': {'start_element': 'CLA-FEA-SIM-START-01', 'end_element': 'CLA-FED-SIM-DUMP-01-START'}}}, 'layout': '/home/xkc85723/Documents/nala-lattices/CLARA/layouts.yaml'})\n"
+      "FrameworkSettings({'settingsFilename': '/home/xkc85723/Documents/laura-lattices/CLARA/./Lattices/clara400_v13_combined.def', 'global': {}, 'generator': {'code': 'astra', 'default': 'clara_400_3ps'}, 'section': '/home/xkc85723/Documents/laura-lattices/CLARA/sections.yaml', 'element_list': '/home/xkc85723/Documents/laura-lattices/CLARA/YAML/', 'groups': {'bunch_compressor': {'type': 'chicane', 'elements': ['CLA-VBC-MAG-DIP-01', 'CLA-VBC-MAG-DIP-02', 'CLA-VBC-MAG-DIP-03', 'CLA-VBC-MAG-DIP-04']}}, 'elements': {}, 'files': {'injector400': {'code': 'astra', 'charge': {'cathode': True, 'space_charge_mode': '2D', 'mirror_charge': True}, 'input': {'particle_definition': 'initial_distribution'}, 'output': {'zstart': 0, 'end_element': 'CLA-S02-SIM-APER-01'}}, 'Linac': {'code': 'elegant', 'output': {'start_element': 'CLA-S02-SIM-APER-01', 'end_element': 'CLA-FEA-SIM-START-01'}}, 'FEBE': {'code': 'elegant', 'charge': {'cathode': False, 'space_charge_mode': '3D'}, 'input': {}, 'output': {'start_element': 'CLA-FEA-SIM-START-01', 'end_element': 'CLA-FED-SIM-DUMP-01-START'}}}, 'layout': '/home/xkc85723/Documents/laura-lattices/CLARA/layouts.yaml'})\n"
      ]
     }
    ],

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/getting-started.rst

@@ -8,9 +8,9 @@ Getting started with SIMBA
 Lattice Definition
 ------------------
 
-Accelerator lattices in :mod:`SIMBA` are derived from the `NALA <https://github.com/astec-stfc/nala/>`_
+Accelerator lattices in :mod:`SIMBA` are derived from the `LAURA <https://github.com/astec-stfc/laura/>`_
 standard lattice format. This is a schema for providing generic descriptions of accelerator elements and
-layouts; see the `NALA documentation <https://nala-accelerator.readthedocs.io/en/latest/#>`_ for more details.
+layouts; see the `LAURA documentation <https://laura-accelerator.readthedocs.io/en/latest/#>`_ for more details.
 
 Given that this format is designed to capture all relevant information about accelerator elements,
 and that it includes a built-in translator module for exporting lattice files to various simulation codes,
@@ -21,10 +21,10 @@ We would be remiss not to begin with a simple FODO:
 
 .. code-block:: python
 
-    from nala.models.element import Quadrupole, Marker  # noqa E402
-    from nala.models.elementList import MachineModel  # noqa E402
-    from nala.Exporters.YAML import export_machine
-    from nala import NALA  # noqa E402
+    from laura.models.element import Quadrupole, Marker  # noqa E402
+    from laura.models.elementList import MachineModel  # noqa E402
+    from laura.Exporters.YAML import export_machine
+    from laura import LAURA  # noqa E402
 
     outdir = "/path/to/lattice/directory"
 
@@ -102,7 +102,7 @@ We would be remiss not to begin with a simple FODO:
         }
     }
 
-    machine = NALA(element_list=[m1, q1f, q1d, m3], layout=layouts, section=sections)
+    machine = LAURA(element_list=[m1, q1f, q1d, m3], layout=layouts, section=sections)
     export_machine(path=f"{outdir}/Lattice", machine=machine, overwrite=True)
     
 Generating an input beam
@@ -113,7 +113,7 @@ The simulation requires a macroparticle distribution to run. This can be generat
 
 .. code-block:: python
 
-    from simba.Codes.Generators import frameworkGenerator
+    from simba.Codes.Generators imoutdirport frameworkGenerator
     import simba.Modules.Beams as rbf
 
     gen = frameworkGenerator(
@@ -147,7 +147,7 @@ This involves passing a group of settings to :mod:`SIMBA`, including:
 * The simulation code used to run each section;
 * Additional settings, such as the enabling of collective effects, or transverse matching parameters for the initial beam;
 * Settings for beam generation;
-* Locations for :mod:`NALA` files.
+* Locations for :mod:`LAURA` files.
 
 These are all read in when :mod:`SIMBA` is instantiated. The example below shows how to create these settings in :mod:`python`;
 alternatively, one can create a settings file in YAML and pass that in; see :ref:`Loading a lattice <loading-a-lattice>`:

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/index.rst

@@ -61,6 +61,7 @@ We are also happy to help with installation and setting up your accelerator latt
    :maxdepth: 2
    :caption: API
    
+   Framework
    Framework_objects
    Framework_elements
    simba.Codes

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/installation.rst

@@ -41,7 +41,11 @@ To check that the install was completed successfully, run this command from the
 Install from pypi / conda-forge
 -------------------------------
 
-WIP.....
+:mod:`SIMBA` is available from pypi:
+
+.. code-block:: bash
+
+    pip install simba-accelerator
 
 Required Dependencies
 ---------------------

{simba_accelerator-0.1.3 → simba_accelerator-0.2.0}/docs/source/loading-a-lattice.rst

@@ -4,16 +4,16 @@ Loading in a Lattice File
 =========================
 
 :ref:`Getting started <getting-started>` demonstrated how to create a
-`NALA <https://github.com/astec-stfc/nala/>`_ lattice in :mod:`python`.
+`LAURA <https://github.com/astec-stfc/laura/>`_ lattice in :mod:`python`.
 This page will describe how to generate a :mod:`SIMBA` instance based on pre-existing
-`NALA <https://github.com/astec-stfc/nala/>`_ element and lattice definitions.
+`LAURA <https://github.com/astec-stfc/laura/>`_ element and lattice definitions.
 
 .. _setup-from-file:
 
 Setting up a Simulation From Files
 ----------------------------------
 
-Given a :mod:`NALA` ``MachineModel``, which contains:
+Given a :mod:`LAURA` ``MachineModel``, which contains:
 
 * All of the elements in an accelerator lattice;
 * The various sections that compose that lattice;
@@ -58,18 +58,18 @@ for the CLARA :cite:`PhysRevAccelBeams.23.044801` :cite:`PhysRevAccelBeams.27.04
       bunch_compressor:
         type: chicane
         elements: [CLA-VBC-MAG-DIP-01, CLA-VBC-MAG-DIP-02, CLA-VBC-MAG-DIP-03, CLA-VBC-MAG-DIP-04]
-    layout: /path/to/nala-lattices/CLARA/layouts.yaml
-    section: /path/to/nala-lattices/CLARA/sections.yaml
-    element_list: /path/to/nala-lattices/CLARA/YAML/
+    layout: /path/to/laura-lattices/CLARA/layouts.yaml
+    section: /path/to/laura-lattices/CLARA/sections.yaml
+    element_list: /path/to/laura-lattices/CLARA/YAML/
 
 This lattice definition would produce several output files (called ``injector400.in``, ``Linac.lte``,
 and ``FEBE.py``) for running in the **ASTRA**, **Elegant** and **Ocelot** beam tracking codes.
 
-The elements are loaded from the directory ``/path/to/nala-lattices/CLARA/YAML/`` defined above.
+The elements are loaded from the directory ``/path/to/laura-lattices/CLARA/YAML/`` defined above.
 
 As this simulation starts from the cathode, the ``input`` definition is required for the first
 `injector400` ``file`` block. An alternative method for starting is to specify ``input/particle_definition`` to
-point to an existing beam file **#TODO add reference to beams page**.
+point to an existing beam file.
 
 For `follow-on` lattice runs, it is sufficient to define the ``output: start_element``, which should match the ``output: end_element`` definition 
 from the previous ``file`` block.
@@ -78,7 +78,7 @@ from the previous ``file`` block.
 Running SIMBA
 -------------
 
-The following example assumes that `NALA <https://github.com/astec-stfc/nala/>`_ has already been installed
+The following example assumes that `LAURA <https://github.com/astec-stfc/laura/>`_ has already been installed
 (see :ref:`Installation <installation>`) and that the :ref:`SimCodes <simcodes>` directory has
 been prepared.
 
@@ -92,7 +92,7 @@ been prepared.
     #       "verbose" will print a progressbar if true
     simcodes_location = "/path/to/simcodes/directory"
     framework = fw.Framework(
-        master_lattice="/path/to/nala-lattices/CLARA",
+        master_lattice="/path/to/laura-lattices/CLARA",
         directory="./example",
         generator_defaults="clara.yaml",
         simcodes_location=simcodes_location,

simba_accelerator-0.2.0/docs/source/simba.Framework_objects.rst

@@ -0,0 +1,7 @@
+simba.Framework_objects module
+==============================
+
+.. automodule:: simba.Framework_objects
+   :members:
+   :show-inheritance:
+   :undoc-members: