gitronics 0.3.2__tar.gz → 0.4.0__tar.gz

{gitronics-0.3.2 → gitronics-0.4.0}/.github/workflows/publish.yml

@@ -2,8 +2,6 @@ name: Publish Python Package
 
 on:
   push:
-    branches:
-      - main
     tags:
       - 'v*.*.*'
 

{gitronics-0.3.2 → gitronics-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitronics
-Version: 0.3.2
+Version: 0.4.0
 Summary: Automatically build an MCNP from a set of files.
 Author-email: Alvaro Cubi <cubiric@hotmail.com>
 License-File: LICENSE

gitronics-0.4.0/src/gitronics/file_readers.py

@@ -0,0 +1,175 @@
+"""
+These functions read and parse the individual files that will make up the composed MCNP
+model. The result is an instance of ParsedBlocks which holds all the sections of the
+final file.
+"""
+
+import logging
+import re
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass
+class _FirstIdAndText:
+    first_id: int
+    text: str
+
+
+@dataclass
+class ParsedBlocks:
+    """Contains all the sections of the MCNP input model."""
+
+    cells: dict[int, str]
+    surfaces: dict[int, str]
+    tallies: dict[int, str]
+    materials: dict[int, str]
+    transforms: dict[int, str]
+    source: str
+
+    @classmethod
+    def empty_instance(cls) -> "ParsedBlocks":
+        """Returns an empty instance of ParsedBlocks."""
+        return ParsedBlocks(
+            cells={}, surfaces={}, tallies={}, materials={}, transforms={}, source=""
+        )
+
+    def add_cells(self, block: _FirstIdAndText) -> None:
+        if block.first_id in self.cells:
+            raise ValueError(
+                "Overwriting cells block with the same first cell ID:"
+                f" {block.first_id}"
+            )
+        self.cells[block.first_id] = block.text
+
+    def add_surfaces(self, block: _FirstIdAndText) -> None:
+        if block.first_id in self.surfaces:
+            raise ValueError(
+                "Overwriting surfaces block with the same first surface ID:"
+                f" {block.first_id}"
+            )
+        self.surfaces[block.first_id] = block.text
+
+    def add_tallies(self, block: _FirstIdAndText) -> None:
+        # Tally files are allowed to not have an ID (e.g. a SSW card)
+        if block.first_id == 0:
+            if 0 in self.tallies:
+                self.tallies[0] += block.text
+            else:
+                self.tallies[0] = block.text
+            return
+        
+        if block.first_id in self.tallies:
+            raise ValueError(
+                "Overwriting tally block with the same first tally ID:"
+                f" {block.first_id}"
+            )
+        self.tallies[block.first_id] = block.text
+
+    def add_materials(self, block: _FirstIdAndText) -> None:
+        if block.first_id in self.materials:
+            raise ValueError(
+                "Overwriting material block with the same first material ID:"
+                f" {block.first_id}"
+            )
+        self.materials[block.first_id] = block.text
+
+    def add_transforms(self, block: _FirstIdAndText) -> None:
+        if block.first_id in self.transforms:
+            raise ValueError(
+                "Overwriting transform block with the same first transform ID:"
+                f" {block.first_id}"
+            )
+        self.transforms[block.first_id] = block.text
+
+    def add_source(self, text: str) -> None:
+        if self.source:
+            raise ValueError("Overwriting source block which is already set.")
+        self.source = text
+
+
+BLANK_LINE = re.compile(r"^\s*\n", flags=re.MULTILINE)
+MCNP_FILE_NEEDED_BLOCKS = 2
+
+
+def _read_mcnp(file: Path) -> tuple[_FirstIdAndText, _FirstIdAndText]:
+    with open(file, encoding="utf-8") as infile:
+        blocks = BLANK_LINE.split(infile.read())
+
+    if len(blocks) < MCNP_FILE_NEEDED_BLOCKS:
+        raise ValueError(
+            f"File {file} does not contain the two blocks: cells and surfaces."
+        )
+
+    cell_block, surfaces_block = blocks[:2]
+
+    match_first_cell_id = re.search(r"^\d+", cell_block, flags=re.MULTILINE)
+    if not match_first_cell_id:
+        raise ValueError(f"Could not parse the first cell ID value in {file}.")
+    first_cell_id = int(match_first_cell_id.group())
+
+    match_first_surface_id = re.search(r"^\*?\d+", surfaces_block, flags=re.MULTILINE)
+    if not match_first_surface_id:
+        raise ValueError(f"Could not parse the first surface ID value in {file}.")
+    first_surface_id = int(match_first_surface_id.group())
+
+    return _FirstIdAndText(first_cell_id, cell_block), _FirstIdAndText(
+        first_surface_id, surfaces_block
+    )
+
+
+def _read_first_block(file: Path) -> _FirstIdAndText:
+    with open(file, encoding="utf-8") as infile:
+        text = BLANK_LINE.split(infile.read())[0]
+        if text[-1] != "\n":
+            text += "\n"
+
+    match_first_id = re.search(r"^\*?[a-zA-Z]*(\d+)", text, flags=re.MULTILINE)
+    if not match_first_id:
+        raise ValueError(f"Could not parse the first ID value in file {file}.")
+    first_id = int(match_first_id.group(1))
+
+    return _FirstIdAndText(first_id, text)
+
+
+def _read_first_block_without_id(file: Path) -> str:
+    with open(file, encoding="utf-8") as infile:
+        text = BLANK_LINE.split(infile.read())[0]
+        if text[-1] != "\n":
+            text += "\n"
+    return text
+
+
+def read_files(files: list[Path]) -> ParsedBlocks:
+    """Reads the files and returns the parsed blocks."""
+    parsed_blocks = ParsedBlocks.empty_instance()
+
+    for file in files:
+        logging.info("Reading file: %s", file)
+        suffix = file.suffix[1:]  # remove the dot like in ".mcnp"
+
+        match suffix:
+            case "mcnp":
+                cells_block, surfaces_block = _read_mcnp(file)
+                parsed_blocks.add_cells(cells_block)
+                parsed_blocks.add_surfaces(surfaces_block)
+            case "tally":
+                try:
+                    block = _read_first_block(file)
+                except ValueError:
+                    block = _FirstIdAndText(0, _read_first_block_without_id(file))
+
+                parsed_blocks.add_tallies(block)
+            case "mat":
+                block = _read_first_block(file)
+                parsed_blocks.add_materials(block)
+            case "transform":
+                block = _read_first_block(file)
+                parsed_blocks.add_transforms(block)
+            case "source":
+                text = _read_first_block_without_id(file)
+                parsed_blocks.add_source(text)
+            case _:
+                raise ValueError(f"Unknown file suffix for: {file}")
+
+    return parsed_blocks

{gitronics-0.3.2 → gitronics-0.4.0}/tests/test_compose_model.py

@@ -1,5 +1,4 @@
 # ruff: noqa: E501
-import logging
 from pathlib import Path
 
 from gitronics.compose_model import compose_model

{gitronics-0.3.2 → gitronics-0.4.0}/tests/test_file_readers.py

@@ -70,6 +70,94 @@ def test_read_file_wrong_suffix():
         read_files([WRONG_FILES_PATH / "wrong_suffix.wrong"])
 
 
+def test_read_tallies_without_id():
+    parsed_blocks = read_files(
+        [
+            VALID_PROJECT_PATH / "data_cards" / "ssw_card.tally",
+            VALID_PROJECT_PATH / "data_cards" / "ssw_card.tally",
+        ]
+    )
+    assert "SSW" in parsed_blocks.tallies[0]
+
+
+def test_read_cells_repeated_first_id():
+    with pytest.raises(
+        ValueError,
+        match="Overwriting cells block with the same first cell ID: 1",
+    ):
+        read_files(
+            [
+                VALID_PROJECT_PATH / "models" / "envelope_structure.mcnp",
+                VALID_PROJECT_PATH / "models" / "envelope_structure.mcnp",
+            ]
+        )
+
+
+def test_read_surfaces_repeated_first_id():
+    with pytest.raises(
+        ValueError,
+        match="Overwriting surfaces block with the same first surface ID: 10",
+    ):
+        read_files(
+            [
+                VALID_PROJECT_PATH / "models" / "filler_model_1.mcnp",
+                VALID_PROJECT_PATH / "models" / "filler_model_repeat_surface.mcnp",
+            ]
+        )
+
+
+def test_read_tallies_repeated_first_id():
+    with pytest.raises(
+        ValueError,
+        match="Overwriting tally block with the same first tally ID: 24",
+    ):
+        read_files(
+            [
+                VALID_PROJECT_PATH / "data_cards" / "fine_mesh.tally",
+                VALID_PROJECT_PATH / "data_cards" / "fine_mesh.tally",
+            ]
+        )
+
+
+def test_read_materials_repeated_first_id():
+    with pytest.raises(
+        ValueError,
+        match="Overwriting material block with the same first material ID: 14",
+    ):
+        read_files(
+            [
+                VALID_PROJECT_PATH / "data_cards" / "materials.mat",
+                VALID_PROJECT_PATH / "data_cards" / "materials.mat",
+            ]
+        )
+
+
+def test_read_transforms_repeated_first_id():
+    with pytest.raises(
+        ValueError,
+        match="Overwriting transform block with the same first transform ID: 1",
+    ):
+        read_files(
+            [
+                VALID_PROJECT_PATH / "data_cards" / "my_transform.transform",
+                VALID_PROJECT_PATH / "data_cards" / "my_transform.transform",
+            ]
+        )
+
+
+def test_read_source_repeated():
+    with pytest.raises(
+        ValueError,
+        match="Overwriting source block which is already set.",
+    ):
+        read_files(
+            [
+                VALID_PROJECT_PATH / "data_cards" / "volumetric_source.source",
+                VALID_PROJECT_PATH / "data_cards" / "volumetric_source.source",
+            ]
+        )
+
+
 MAIN_INPUT_CELLS = """Title of the MCNP model
 C
 C

gitronics-0.4.0/tests/test_resources/valid_project/data_cards/ssw_card.tally

@@ -0,0 +1,3 @@
+C This will be considered a tally card even tho it doesnt have a first ID of the 
+C  form FXX4: n
+SSW 4001 4002 4003 4004

{gitronics-0.3.2 → gitronics-0.4.0}/tests/test_resources/valid_project/data_cards/volumetric_source.source

@@ -4,4 +4,4 @@ sdef sur 398 nrm=-1 dir=d1 wgt=132732289.6141
 sb1    -21  2
 lost 1000
 prdmp j 1e7 
-nps  1e9 
+nps  1e9 

gitronics-0.4.0/tests/test_resources/valid_project/models/filler_model_repeat_surface.mcnp

@@ -0,0 +1,33 @@
+C Filler model 1
+9910   14    -7.89      10 -20 40 -30
+           imp:n=1.0   imp:p=1.0  u=121
+9920     0      10 -20 80 730 -70 -60 -50
+           imp:n=1.0   imp:p=1.0   u=121
+
+C Surfaces model 1
+10     PZ  -1.4030000e+02
+20     PZ   4.6300000e+01
+30     CZ    160.700000
+40     CZ    144.900000
+
+C Data cards that will not be read by the global model
+m14   1001.31c  2.379E-02  $ H-1
+      5010.31c  2.350E-04  $ B10
+      5011.31c  9.469E-04  $ B11
+      8016.31c  4.276E-02  $ O 
+     11023.31c  2.068E-04  $ Na   
+c     12000.31c  3.768E-05  $ Mg 
+     12024.31c  2.976E-05  $ Mg-24  78.99%
+     12025.31c  3.768E-06  $ Mg-25  10.0 %
+     12026.31c  4.149E-06  $ Mg-26  11.01%
+     13027.31c  6.034E-04  $ Al 
+c     14000.31c  1.239E-02  $ Si 
+     14028.31c  1.143E-02  $ Si-28  92.23%
+     14029.31c  5.786E-04  $ Si-29   4.67%
+c
+mode  n 
+sdef sur 398 nrm=-1 dir=d1 wgt=132732289.6141
+sb1    -21  2
+lost 1000
+prdmp j 1e7 
+nps  1e9  

gitronics-0.4.0/tests/test_resources/valid_project/models/filler_model_repeat_surface.metadata

@@ -0,0 +1,2 @@
+transformations:
+  my_envelope_name_1: "*(10)"

gitronics-0.3.2/src/gitronics/file_readers.py

@@ -1,133 +0,0 @@
-"""
-These functions read and parse the individual files that will make up the composed MCNP
-model. The result is an instance of ParsedBlocks which holds all the sections of the
-final file.
-"""
-
-import logging
-import re
-from dataclasses import dataclass
-from pathlib import Path
-
-
-@dataclass
-class ParsedBlocks:
-    """Contains all the sections of the MCNP input model."""
-
-    cells: dict[int, str]
-    surfaces: dict[int, str]
-    tallies: dict[int, str]
-    materials: dict[int, str]
-    transforms: dict[int, str]
-    source: str
-
-    @classmethod
-    def empty_instance(cls) -> "ParsedBlocks":
-        """Returns an empty instance of ParsedBlocks."""
-        return ParsedBlocks(
-            cells={}, surfaces={}, tallies={}, materials={}, transforms={}, source=""
-        )
-
-    def add_file(self, file: Path) -> None:
-        """Adds the file if the suffix is recognized."""
-        suffix = file.suffix[1:]  # remove the dot like in ".mcnp"
-
-        match suffix:
-            case "mcnp":
-                self._add_mcnp_file(file)
-
-            case "tally":
-                self._add_tally_file(file)
-
-            case "mat":
-                self._add_material_file(file)
-
-            case "transform":
-                self._add_transform_file(file)
-
-            case "source":
-                self._add_source_file(file)
-
-            case _:
-                raise ValueError(f"Unknown file suffix for: {file}")
-
-    def _add_mcnp_file(self, file: Path) -> None:
-        cells_block, surfaces_block = _read_mcnp(file)
-        self.cells[cells_block.first_id] = cells_block.text
-        self.surfaces[surfaces_block.first_id] = surfaces_block.text
-
-    def _add_tally_file(self, file: Path) -> None:
-        block = _read_first_block(file)
-        self.tallies[block.first_id] = block.text
-
-    def _add_material_file(self, file: Path) -> None:
-        block = _read_first_block(file)
-        self.materials[block.first_id] = block.text
-
-    def _add_transform_file(self, file: Path) -> None:
-        block = _read_first_block(file)
-        self.transforms[block.first_id] = block.text
-
-    def _add_source_file(self, file: Path) -> None:
-        self.source = _read_first_block(file).text
-
-
-def read_files(files: list[Path]) -> ParsedBlocks:
-    """Reads the files and returns the parsed blocks."""
-    parsed_blocks = ParsedBlocks.empty_instance()
-
-    for file in files:
-        logging.info("Reading file: %s", file)
-        parsed_blocks.add_file(file)
-
-    return parsed_blocks
-
-
-@dataclass
-class _FirstIdAndText:
-    first_id: int
-    text: str
-
-
-BLANK_LINE = re.compile(r"^\s*\n", flags=re.MULTILINE)
-MCNP_FILE_NEEDED_BLOCKS = 2
-
-
-def _read_mcnp(file: Path) -> tuple[_FirstIdAndText, _FirstIdAndText]:
-    with open(file, encoding="utf-8") as infile:
-        blocks = BLANK_LINE.split(infile.read())
-
-    if len(blocks) < MCNP_FILE_NEEDED_BLOCKS:
-        raise ValueError(
-            f"File {file} does not contain the two blocks: cells and surfaces."
-        )
-
-    cells, surfaces = blocks[:2]
-
-    match_first_cell_id = re.search(r"^\d+", cells, flags=re.MULTILINE)
-    if not match_first_cell_id:
-        raise ValueError(f"Could not parse the first cell ID value in {file}.")
-    first_cell_id = int(match_first_cell_id.group())
-
-    match_first_surface_id = re.search(r"^\*?\d+", surfaces, flags=re.MULTILINE)
-    if not match_first_surface_id:
-        raise ValueError(f"Could not parse the first surface ID value in {file}.")
-    first_surface_id = int(match_first_surface_id.group())
-
-    return _FirstIdAndText(first_cell_id, cells), _FirstIdAndText(
-        first_surface_id, surfaces
-    )
-
-
-def _read_first_block(file: Path) -> _FirstIdAndText:
-    with open(file, encoding="utf-8") as infile:
-        text = BLANK_LINE.split(infile.read())[0]
-        if text[-1] != "\n":
-            text += "\n"
-
-    match_first_id = re.search(r"^\*?[a-zA-Z]*(\d+)", text, flags=re.MULTILINE)
-    if not match_first_id:
-        raise ValueError(f"Could not parse the first ID value in file {file}.")
-    first_id = int(match_first_id.group(1))
-
-    return _FirstIdAndText(first_id, text)