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

simba_accelerator-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{simba_accelerator-0.1.3 → simba_accelerator-0.3.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.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simba-accelerator
-Version: 0.1.3
+Version: 0.3.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,8 @@ 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
+License-File: LICENSE
+Requires-Dist: deepdiff>=8.6
 Requires-Dist: h5py>=2.10
 Requires-Dist: munch>=2.5
 Requires-Dist: numpy>=2
@@ -38,21 +39,20 @@ 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: license-file
 Dynamic: requires-python
 
-# SIMBA: Simulation Interface for Machine and Beam Applications or
+# SIMBA: Simulations for Integrated Modeling of Beams in Accelerators
 *Improving accelerators through consistent, complete, and easy to use simulations.*
 
 ## Mission
@@ -61,7 +61,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 +98,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 +130,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 +177,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 +209,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.3.0}/README.md

@@ -1,4 +1,4 @@
-# SIMBA: Simulation Interface for Machine and Beam Applications or
+# SIMBA: Simulations for Integrated Modeling of Beams in Accelerators
 *Improving accelerators through consistent, complete, and easy to use simulations.*
 
 ## Mission
@@ -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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.0/docs/source/simba.Framework_objects.rst

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