m_0: renamed atomic_or_weight

Author: BitterB0NG0

docs/source/examples.md

@@ -41,7 +41,7 @@ Creating a material input for water:
     water = pymcnp.inp.Material.from_formula(
         0,
         {'H2O': 1},
-        atomic_or_weight=True,
+        is_weight=True,
     )
     print(water.to_mcnp())
 
@@ -67,7 +67,7 @@ Using a combination of more complicated materials:
             'K2O': 0.010,
             'CaSO4H4O2': 0.050,
         },
-        atomic_or_weight=False,
+        is_weight=False,
     )
     print(clinker_concrete.to_mcnp())
 

examples/example_create_material_card.py

@@ -15,7 +15,7 @@
 water = pymcnp.inp.Material.from_formula(
     0,
     {'H2O': 1},
-    atomic_or_weight=True,
+    is_weight=True,
 )
 print(water.to_mcnp())
 
@@ -31,14 +31,14 @@
         'K2O': 0.010,
         'CaSO4H4O2': 0.050,
     },
-    atomic_or_weight=False,
+    is_weight=False,
 )
 print(clinker_concrete.to_mcnp())
 
 print('\n### LANTHANUM(III) BROMIDE ###')
 labr3 = pymcnp.inp.Material.from_formula(
     2,
     {'LaBr3': 1},
-    atomic_or_weight=True,
+    is_weight=True,
 )
 print(labr3.to_mcnp())

scripts/inp_data.py

@@ -4375,14 +4375,14 @@ def draw(self):
                     ],
                     extra='''
     @staticmethod
-    def from_formula(number: int, formulas: dict[str, float], atomic_or_weight: bool = True):
+    def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True):
         """
         Generates ``M_0`` from INP.
 
         Parameters:
             number: Arbitrary material number.
             formulas: Dictionary of formulas and atomic/weight fractions.
-            atomic_or_weight: Atomtic/Weight fraction true/false flag.
+            is_weight: Weight (atmoic) fraction true (false) flag.
 
         Returns:
             ``M_0`` object.
@@ -4397,7 +4397,7 @@ def from_formula(number: int, formulas: dict[str, float], atomic_or_weight: bool
             for element in composition:
                 compound_fraction = (
                     composition[element].fraction
-                    if atomic_or_weight
+                    if is_weight
                     else composition[element].mass / formula.mass
                 )
 
@@ -4413,7 +4413,7 @@ def from_formula(number: int, formulas: dict[str, float], atomic_or_weight: bool
                     types.Substance(
                         zaid,
                         types.Real(
-                            (-1 if atomic_or_weight else 1)
+                            (-1 if is_weight else 1)
                             * mixture_fraction
                             * compound_fraction
                             * isotropic_fraction

src/pymcnp/inp/data/M.py

@@ -69,14 +69,14 @@ def __init__(
         self.options: typing.Final[types.Tuple[m_0.MOption_0]] = options
 
     @staticmethod
-    def from_formula(number: int, formulas: dict[str, float], atomic_or_weight: bool = True):
+    def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True):
         """
         Generates ``M_0`` from INP.
 
         Parameters:
             number: Arbitrary material number.
             formulas: Dictionary of formulas and atomic/weight fractions.
-            atomic_or_weight: Atomtic/Weight fraction true/false flag.
+            is_weight: Weight (atomic) fraction true (false) flag.
 
         Returns:
             ``M_0`` object.
@@ -91,7 +91,7 @@ def from_formula(number: int, formulas: dict[str, float], atomic_or_weight: bool
             for element in composition:
                 compound_fraction = (
                     composition[element].fraction
-                    if atomic_or_weight
+                    if is_weight
                     else composition[element].mass / formula.mass
                 )
 
@@ -107,7 +107,7 @@ def from_formula(number: int, formulas: dict[str, float], atomic_or_weight: bool
                     types.Substance(
                         zaid,
                         types.Real(
-                            (-1 if atomic_or_weight else 1)
+                            (-1 if is_weight else 1)
                             * mixture_fraction
                             * compound_fraction
                             * isotropic_fraction