Create an ab initio parse method to quickly make new objects from an MCNP string.

doc/source/changelog.rst

@@ -2,16 +2,15 @@
 MontePy Changelog
 *****************
 
-1.0.0 releases
-==============
+1.0 releases
+============
 
 #Next Version#
 --------------
 
 **Features Added**
 
 * Redesigned how Materials hold Material_Components. See :ref:`migrate 0 1` (:pull:`507`). 
-
 * Made it easier to create an Isotope, or now Nuclide: ``montepy.Nuclide("H-1.80c")`` (:issue:`505`).
 * When a typo in an object attribute is made an Error is raised rather than silently having no effect (:issue:`508`).
 * Improved material printing to avoid very long lists of components (:issue:`144`).
@@ -22,6 +21,8 @@ MontePy Changelog
 * Made ``Material.is_atom_fraction`` settable (:issue:`511`). 
 * Made NumberedObjectCollections act like a set (:issue:`138`).
 * Automatically added children objects, e.g., the surfaces in a cell, to the problem when the cell is added to the problem (:issue:`63`).
+* Added ability to parse all MCNP objects from a string (:pull:`595`).
+* Added function: :func:`~montepy.mcnp_problem.MCNP_Problem.parse` to parse arbitrary MCNP object (:pull:`595`).
 
 **Bugs Fixed**
 

doc/source/starting.rst

@@ -267,8 +267,7 @@ The ``NumberedObjectCollection`` has various mechanisms internally to avoid numb
 
         import montepy
         prob = montepy.read_input("tests/inputs/test.imcnp")
-        cell = montepy.Cell()
-        cell.number = 2
+        cell = montepy.Cell(number = 2)
         prob.cells.append(cell)
 
 .. testoutput::
@@ -334,21 +333,23 @@ Using the generators in this way does not cause any issues, but there are ways t
 by making "stale" information.
 This can be done by making a copy of it with ``list()``. 
 
->>> for num in problem.cells.numbers:
-...   print(num)
-1
-2
-3
-99
-5
->>> numbers = list(problem.cells.numbers)
->>> numbers
-[1, 2, 3, 99, 5]
->>> problem.cells[1].number = 1000
->>> 1000 in problem.cells.numbers
-True
->>> 1000 in numbers
-False
+.. doctest::
+
+        >>> for num in problem.cells.numbers:
+        ...   print(num)
+        1
+        2
+        3
+        99
+        5
+        >>> numbers = list(problem.cells.numbers)
+        >>> numbers
+        [1, 2, 3, 99, 5]
+        >>> problem.cells[1].number = 1000
+        >>> 1000 in problem.cells.numbers
+        True
+        >>> 1000 in numbers
+        False
 
 Oh no! When we made a list of the numbers we broke the link, and the new list won't update when the numbers of the cells change, 
 and you can cause issues this way.
@@ -364,6 +365,35 @@ If a ``Cell`` or a group of ``Cells`` are cloned their numbers will be to change
 However, if a whole :class:`~montepy.mcnp_problem.MCNP_Problem` is cloned these objects will not have their numbers changed.
 For an example for how to clone a numbered object see :ref:`Cloning a Cell`.
 
+Creating Objects from a String
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sometimes its more convenient to create an MCNP object from its input string for MCNP, rather than setting a lot of properties,
+or the object you need isn't supported by MontePy yet.
+In this case there are a few ways to generate this object.
+First all :class:`~montepy.mcnp_object.MCNP_Object` constructors can take a string:
+
+.. doctest::
+
+   >>> cell = montepy.Cell("1 0 -2 imp:n=1")
+   >>> cell.number
+   1
+   >>> cell.importance[montepy.Particle.NEUTRON]
+   1.0
+
+This object is still unlinked from other objects, and won't be kept with a problem.
+So there is also :func:`~montepy.mcnp_problem.MCNP_Problem.parse`. 
+This takes a string, and then creates the MCNP object,
+links it to the problem,
+links it to its other objects (e.g., surfaces, materials, etc.),
+and appends it to necessary collections:
+
+.. testcode::
+
+   cell = problem.parse("123 0 -1005")
+   assert cell in problem.cells
+   assert cell.surfaces[1005] is problem.surfaces[1005]
+
 Surfaces
 --------
 
@@ -590,24 +620,18 @@ Order of precedence and grouping is automatically handled by Python so you can e
 .. testcode::
 
    # build blank surfaces 
-   bottom_plane = montepy.AxisPlane()
+   bottom_plane = montepy.AxisPlane(number=1)
    bottom_plane.location = 0.0
-   top_plane = montepy.AxisPlane()
+   top_plane = montepy.AxisPlane(number=2)
    top_plane.location = 10.0
-   fuel_cylinder = montepy.CylinderOnAxis()
+   fuel_cylinder = montepy.CylinderOnAxis(number=3)
    fuel_cylinder.radius = 1.26 / 2
-   clad_cylinder = montepy.CylinderOnAxis()
+   clad_cylinder = montepy.CylinderOnAxis( number=4)
    clad_cylinder.radius = (1.26 / 2) + 1e-3 # fuel, gap, cladding
-   clad_od = montepy.surfaces.CylinderOnAxis()
+   clad_od = montepy.CylinderOnAxis(number=5)
    clad_od.radius = clad_cylinder.radius + 0.1 # add thickness
-   other_fuel = montepy.surfaces.CylinderOnAxis()
+   other_fuel = montepy.CylinderOnAxis(number=6)
    other_fuel.radius = 3.0
-   other_fuel.number = 10
-   bottom_plane.number = 1
-   top_plane.number = 2
-   fuel_cylinder.number = 3
-   clad_cylinder.number = 4
-   clad_od.number = 5
 
    #make weird truncated fuel sample
    slug_half_space = +bottom_plane & -top_plane & -fuel_cylinder
@@ -802,8 +826,7 @@ You can also easy apply a transform to the filling universe with:
 .. testcode::
 
    import numpy as np
-   transform = montepy.data_inputs.transform.Transform()
-   transform.number = 5
+   transform = montepy.data_inputs.transform.Transform(number=5)
    transform.displacement_vector = np.array([1, 2, 0])
    cell.fill.transform = transform
 

montepy/__init__.py

@@ -7,6 +7,7 @@
 You will receive an MCNP_Problem object that you will interact with.
 """
 
+from . import data_inputs
 from . import input_parser
 from . import constants
 import importlib.metadata

montepy/cell.py

@@ -1,10 +1,11 @@
-# 2024, Battelle Energy Alliance, LLC All Rights Reserved.
+# Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved.
 from __future__ import annotations
-
 import copy
 import itertools
 import numbers
+from typing import Union
 
+import montepy
 from montepy.cells import Cells
 from montepy.constants import BLANK_SPACE_CONTINUE
 from montepy.data_inputs import importance, fill, lattice_input, universe_input, volume
@@ -64,15 +65,20 @@ class Cell(Numbered_MCNP_Object):
 
         complement = ~cell
 
-
     .. seealso::
 
             * :manual63sec:`5.2`
             * :manual62:`55`
 
-    :param input: the input for the cell definition
-    :type input: Input
+    .. versionchanged:: 1.0.0
+
+        Added number parameter
 
+
+    :param input: The Input syntax object this will wrap and parse.
+    :type input: Union[Input, str]
+    :param number: The number to set for this object.
+    :type number: int
     """
 
     _ALLOWED_KEYWORDS = {
@@ -105,7 +111,12 @@ class Cell(Numbered_MCNP_Object):
 
     _parser = CellParser()
 
-    def __init__(self, input: montepy.input_parser.mcnp_input.Input = None):
+    def __init__(
+        self,
+        input: Union[montepy.input_parser.mcnp_input.Input, str] = None,
+        number: int = None,
+    ):
+        self._BLOCK_TYPE = montepy.input_parser.block_type.BlockType.CELL
         self._CHILD_OBJ_MAP = {
             "material": Material,
             "surfaces": Surface,
@@ -119,10 +130,9 @@ def __init__(self, input: montepy.input_parser.mcnp_input.Input = None):
         self._density_node = self._generate_default_node(float, None)
         self._surfaces = Surfaces()
         self._complements = Cells()
-        self._number = self._generate_default_node(int, -1)
-        super().__init__(input, self._parser)
+        super().__init__(input, self._parser, number)
         if not input:
-            self._generate_default_tree()
+            self._generate_default_tree(number)
         self._old_number = copy.deepcopy(self._tree["cell_num"])
         self._number = self._tree["cell_num"]
         mat_tree = self._tree["material"]
@@ -607,7 +617,7 @@ def _update_values(self):
         for input_class, (attr, _) in self._INPUTS_TO_PROPERTY.items():
             getattr(self, attr)._update_values()
 
-    def _generate_default_tree(self):
+    def _generate_default_tree(self, number: int = None):
         material = syntax_node.SyntaxNode(
             "material",
             {
@@ -619,7 +629,7 @@ def _generate_default_tree(self):
         self._tree = syntax_node.SyntaxNode(
             "cell",
             {
-                "cell_num": self._generate_default_node(int, None),
+                "cell_num": self._generate_default_node(int, number),
                 "material": material,
                 "geometry": None,
                 "parameters": syntax_node.ParametersNode(),

montepy/data_inputs/data_input.py

@@ -1,4 +1,5 @@
 # Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved.
+from __future__ import annotations
 from abc import abstractmethod
 import copy
 
@@ -14,6 +15,7 @@
 from montepy.mcnp_object import MCNP_Object
 
 import re
+from typing import Union
 
 
 class _ClassifierInput(Input):
@@ -43,7 +45,7 @@ class DataInputAbstract(MCNP_Object):
     Parent class to describe all MCNP data inputs.
 
     :param input: the Input object representing this data input
-    :type input: Input
+    :type input: Union[Input, str]
     :param fast_parse: Whether or not to only parse the first word for the type of data.
     :type fast_parse: bool
     """
@@ -52,17 +54,29 @@ class DataInputAbstract(MCNP_Object):
 
     _classifier_parser = ClassifierParser()
 
-    def __init__(self, input=None, fast_parse=False):
+    def __init__(
+        self,
+        input: Union[montepy.input_parser.mcnp_input.Input, str] = None,
+        fast_parse=False,
+    ):
         self._particles = None
         if not fast_parse:
             super().__init__(input, self._parser)
             if input:
                 self.__split_name(input)
         else:
-            input = copy.copy(input)
-            input.__class__ = _ClassifierInput
+            if input:
+                if isinstance(input, str):
+                    input = _ClassifierInput(
+                        input.split("\n"),
+                        montepy.input_parser.block_type.BlockType.DATA,
+                    )
+                else:
+                    input = copy.copy(input)
+                    input.__class__ = _ClassifierInput
             super().__init__(input, self._classifier_parser)
-            self.__split_name(input)
+            if input:
+                self.__split_name(input)
 
     @staticmethod
     @abstractmethod

montepy/data_inputs/material.py

@@ -1,13 +1,15 @@
 # Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved.
 from __future__ import annotations
-
-import copy
 import collections as co
+import copy
 import itertools
 import math
+import re
 from typing import Generator, Union
+import warnings
 import weakref
 
+import montepy
 from montepy.data_inputs import data_input, thermal_scattering
 from montepy.data_inputs.nuclide import Library, Nucleus, Nuclide
 from montepy.data_inputs.element import Element
@@ -19,10 +21,6 @@
 from montepy.errors import *
 from montepy.utilities import *
 from montepy.particle import LibraryType
-import montepy
-
-import re
-import warnings
 
 
 MAX_PRINT_ELEMENTS: int = 5
@@ -265,6 +263,7 @@ class Material(data_input.DataInputAbstract, Numbered_MCNP_Object):
         80p
         00c
 
+    .. versionchanged:: 1.0.0
 
     .. seealso::
 
@@ -273,15 +272,24 @@ class Material(data_input.DataInputAbstract, Numbered_MCNP_Object):
 
     .. versionchanged:: 1.0.0
 
-        This was the primary change for this release. For more details on what changed see :ref:`migrate 0 1`.
+        * Added number parameter
+        * This was the primary change for this release. For more details on what changed see :ref:`migrate 0 1`.
 
-    :param input: the input that contains the data for this material
-    :type input: Input
+    :param input: The Input syntax object this will wrap and parse.
+    :type input: Union[Input, str]
+    :param parser: The parser object to parse the input with.
+    :type parser: MCNP_Parser
+    :param number: The number to set for this object.
+    :type number: int
     """
 
     _parser = MaterialParser()
 
-    def __init__(self, input: montepy.input_parser.mcnp_input.Input = None):
+    def __init__(
+        self,
+        input: Union[montepy.input_parser.mcnp_input.Input, str] = None,
+        number: int = None,
+    ):
         self._components = []
         self._thermal_scattering = None
         self._is_atom_fraction = True
@@ -291,6 +299,7 @@ def __init__(self, input: montepy.input_parser.mcnp_input.Input = None):
         self._nuclei = set()
         self._default_libs = _DefaultLibraries(self)
         super().__init__(input)
+        self._load_init_num(number)
         if input:
             num = self._input_number
             self._old_number = copy.deepcopy(num)
@@ -342,6 +351,7 @@ def _grab_default(self, param: syntax_node.SyntaxNode):
     def _create_default_tree(self):
         classifier = syntax_node.ClassifierNode()
         classifier.number = self._number
+        classifier.number.never_pad = True
         classifier.prefix = syntax_node.ValueNode("M", str, never_pad=True)
         classifier.padding = syntax_node.PaddingNode(" ")
         mats = syntax_node.MaterialsNode("mat stuff")