gitronics 0.3.2__py3-none-any.whl

gitronics/__init__.py

@@ -0,0 +1,4 @@
+from gitronics.generate_model import generate_model
+from gitronics.helpers import ProjectParameters
+
+__all__ = ["generate_model", "ProjectParameters"]

gitronics/compose_model.py

@@ -0,0 +1,42 @@
+"""
+These functions are used to compose the MCNP model from the blocks of cards that were
+read and parsed previously.
+"""
+
+import logging
+from io import StringIO
+from typing import TextIO
+
+from gitronics.file_readers import ParsedBlocks
+
+
+def compose_model(parsed_data: ParsedBlocks) -> str:
+    """
+    Takes the parsed blocks obtained from the file_readers and composes the MCNP model
+    as a string.
+    """
+    logging.info("Composing model")
+    model = StringIO()
+
+    _write_cards_on_model(parsed_data.cells, model)
+    model.write("\n")
+
+    _write_cards_on_model(parsed_data.surfaces, model)
+    model.write("\n")
+
+    for card_dictionary in [
+        parsed_data.materials,
+        parsed_data.tallies,
+        parsed_data.transforms,
+    ]:
+        _write_cards_on_model(card_dictionary, model)
+
+    model.write(parsed_data.source)
+
+    return model.getvalue()
+
+
+def _write_cards_on_model(card_dictionary: dict[int, str], model: TextIO) -> None:
+    card_ids = sorted(card_dictionary.keys())
+    for card_id in card_ids:
+        model.write(card_dictionary[card_id])

gitronics/file_discovery.py

@@ -0,0 +1,29 @@
+from pathlib import Path
+
+from gitronics.helpers import ALLOWED_SUFFIXES
+
+
+def get_valid_file_paths(project_root: Path) -> dict[str, Path]:
+    """Gets all the file paths with allowed suffixes in the project as a dictionary
+    `name: path`."""
+    all_paths = get_all_file_paths(project_root)
+
+    valid_suffix_paths = {}
+    for path in all_paths:
+        if path.suffix in ALLOWED_SUFFIXES:
+            file_name = path.stem
+            valid_suffix_paths[file_name] = path
+
+    return valid_suffix_paths
+
+
+def get_all_file_paths(project_root: Path) -> list[Path]:
+    """
+    Gets all the file paths in the project, including non-allowed suffixes.
+    """
+    paths_list = []
+    for file in project_root.rglob("*"):
+        if file.is_file():
+            paths_list.append(file.resolve())
+
+    return paths_list

gitronics/file_readers.py

@@ -0,0 +1,133 @@
+"""
+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)

gitronics/generate_model.py

@@ -0,0 +1,130 @@
+"""
+This file contains the generate_model function, the only function a user needs to call
+to generate the MCNP model.
+"""
+
+import logging
+import re
+from datetime import datetime
+from importlib.metadata import version
+
+import yaml
+
+from gitronics.compose_model import compose_model
+from gitronics.file_readers import ParsedBlocks, read_files
+from gitronics.helpers import Config, GitronicsError, ProjectParameters
+from gitronics.project_checker import ProjectChecker
+from gitronics.project_manager import ProjectManager
+
+PLACEHOLDER_PAT = re.compile(r"\$\s+FILL\s*=\s*(\w+)\s*")
+
+
+def generate_model(
+    configuration_name: str, project_parameters: ProjectParameters
+) -> None:
+    # Set up logging
+    logging.basicConfig(
+        level=logging.INFO,
+        format="%(asctime)s - %(levelname)s - %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+        filename=project_parameters.write_path / "model_generation.log",
+        filemode="w",
+    )
+    # Check the whole project
+    project_manager = ProjectManager(project_parameters)
+    ProjectChecker(project_manager).check_project()
+    # Read the configuration and assemble the model as a text string
+    config = project_manager.read_configuration(configuration_name)
+    text = _assemble_model(project_manager, config)
+    # Write the model to a file
+    with open(
+        project_parameters.write_path / f"assembled_{config.name}.mcnp",
+        "w",
+        encoding="utf-8-sig",
+    ) as infile:
+        infile.write(text)
+    _dump_metadata(project_parameters, config)
+    logging.info("Model generation completed.")
+
+
+def _assemble_model(project_manager: ProjectManager, config: Config) -> str:
+    logging.info("Generating model for configuration: %s", config.name)
+    file_paths_to_include = project_manager.get_included_paths(config)
+    parsed_blocks = read_files(file_paths_to_include)
+    _fill_envelope_cards(parsed_blocks, project_manager, config)
+    text = compose_model(parsed_blocks)
+    return text
+
+
+def _fill_envelope_cards(
+    parsed_blocks: ParsedBlocks, project_manager: ProjectManager, config: Config
+) -> None:
+    logging.info("Preparing FILL cards in the envelope structure.")
+    envelope_structure_id = _get_envelope_structure_first_cell_id(
+        project_manager, config
+    )
+    text = parsed_blocks.cells[envelope_structure_id]
+
+    if not config.envelopes:
+        logging.info("No envelopes to fill, skipping FILL cards.")
+        return
+
+    fill_cards = {}
+    for envelope_name, filler_name in config.envelopes.items():
+        # If the envelope is left empty in the configuration do not fill
+        if not filler_name:
+            continue
+
+        # Create the fill card
+        universe_id = project_manager.get_universe_id(filler_name)
+        transform = project_manager.get_transformation(filler_name, envelope_name)
+        if transform:
+            transform = transform.strip()
+            if transform.startswith("*"):
+                fill_card = f" *FILL = {universe_id} {transform[1:]} "
+            else:
+                fill_card = f" FILL = {universe_id} {transform} "
+        else:
+            fill_card = f" FILL = {universe_id} "
+        fill_card += f"\n           $ {envelope_name} \n"
+        fill_cards[envelope_name] = fill_card
+
+    # Modify the text
+    lines = text.splitlines(keepends=True)
+    for i, line in enumerate(lines):
+        match_placeholder = PLACEHOLDER_PAT.search(line)
+        if match_placeholder:
+            envelope_name = match_placeholder.group(1)
+            if envelope_name in fill_cards:
+                lines[i] = re.sub(PLACEHOLDER_PAT, fill_cards[envelope_name], lines[i])
+    text = "".join(lines)
+
+    # Update the ParsedBlocks with the new text for the envelope structure
+    parsed_blocks.cells[envelope_structure_id] = text
+
+
+def _get_envelope_structure_first_cell_id(
+    project_manager: ProjectManager, config: Config
+) -> int:
+    assert config.envelope_structure in project_manager.file_paths
+    path = project_manager.file_paths[config.envelope_structure]
+    with open(path, encoding="utf-8") as infile:
+        for line in infile:
+            match_first_cell_id = re.match(r"^(\d+)", line)
+            if match_first_cell_id:
+                return int(match_first_cell_id.group(1))
+    raise GitronicsError(f"Could not find the first cell ID in {path}.")
+
+
+def _dump_metadata(project_parameters: ProjectParameters, config: Config) -> None:
+    with open(
+        project_parameters.write_path / f"assembled_{config.name}.metadata",
+        "w",
+        encoding="utf-8",
+    ) as infile:
+        metadata = {
+            "configuration_name": config.name,
+            "gitronics_version": version("gitronics"),
+            "build_date": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+        }
+        yaml.dump(metadata, infile, default_flow_style=False, sort_keys=False)

gitronics/helpers.py

@@ -0,0 +1,37 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+ALLOWED_SUFFIXES = {".mcnp", ".transform", ".mat", ".source", ".tally", ".yaml", ".yml"}
+
+TYPE_BY_SUFFIX = {
+    ".mcnp": "Geometry",
+    ".transform": "Transform",
+    ".mat": "Material",
+    ".source": "Source",
+    ".tally": "Tally",
+    ".yaml": "Configuration",
+    ".yml": "Configuration",
+}
+
+
+@dataclass
+class ProjectParameters:
+    root_folder_path: Path
+    write_path: Path
+    extra_metadata_fields: list[str] | None = None
+
+
+@dataclass
+class Config:
+    name: str
+    overrides: str | None
+    envelope_structure: str
+    envelopes: dict[str, str]
+    source: str | None
+    tallies: list[str] | None
+    materials: list[str] | None
+    transforms: list[str] | None
+
+
+class GitronicsError(Exception):
+    """Base class for all Gitronics exceptions."""

gitronics/project_checker.py

@@ -0,0 +1,288 @@
+import logging
+import re
+from dataclasses import dataclass, field
+from pathlib import Path
+
+import polars as pl
+from xlsxwriter import Workbook  # type: ignore
+
+from gitronics.file_discovery import get_all_file_paths
+from gitronics.helpers import (
+    ALLOWED_SUFFIXES,
+    TYPE_BY_SUFFIX,
+    Config,
+    GitronicsError,
+)
+from gitronics.project_manager import ProjectManager
+
+PLACEHOLDER_PAT = re.compile(r"\$\s+FILL\s*=\s*(\w+)\s*")
+
+
+@dataclass
+class ConfigSummaryTables:
+    configuration_and_structure: pl.DataFrame
+    envelopes: pl.DataFrame
+    data_files: pl.DataFrame
+
+
+@dataclass
+class SummaryData:
+    all_files_info: pl.DataFrame | None = None
+    config_summaries: dict[str, ConfigSummaryTables] = field(default_factory=dict)
+
+
+class ProjectChecker:
+    def __init__(self, project_manager: ProjectManager):
+        self.project_manager = project_manager
+        self.summary_data = SummaryData()
+
+    def check_project(self) -> None:
+        """Checks the whole project for potential issues and creates a summary with
+        all the files. It also checks the validity of all the configurations."""
+        logging.info("Checking the validity of the whole project")
+        file_paths = self._get_file_paths()
+        self._check_no_duplicate_names(file_paths)
+        self._check_metadata_files_exist_for_mcnp_models(file_paths)
+        self._update_summary_data_with_all_files_info(
+            file_paths, self.project_manager.parameters.extra_metadata_fields
+        )
+        self._check_all_configurations(file_paths)
+        self._write_excel_summary(self.project_manager.parameters.write_path)
+
+    def _check_all_configurations(self, paths: list[Path]) -> None:
+        """Check all the configurations found in the project (files with .yaml or .yml
+        suffix)."""
+        configuration_files = [
+            path for path in paths if path.suffix in {".yaml", ".yml"}
+        ]
+        for config_path in configuration_files:
+            configuration_name = config_path.stem
+            config = self.project_manager.read_configuration(configuration_name)
+            self.check_configuration(config)
+
+    def check_configuration(self, config: Config) -> None:
+        logging.info("Checking configuration: %s", config.name)
+        self._check_envelope_structure(config)
+        self._check_envelopes(config)
+        self._check_fillers(config)
+        self._check_source(config)
+        self._check_tallies(config)
+        self._check_materials(config)
+        self._check_transforms(config)
+        self._trigger_warnings(config)
+        self._update_summary_data_with_config(config)
+
+    def _get_file_paths(self) -> list[Path]:
+        all_file_paths = get_all_file_paths(self.project_manager.project_root)
+        return [path for path in all_file_paths if path.suffix in ALLOWED_SUFFIXES]
+
+    def _check_no_duplicate_names(self, paths: list[Path]) -> None:
+        names = set()
+        for path in paths:
+            name = path.stem
+            if name in names:
+                raise GitronicsError(f"Duplicate file name found: {name}")
+            names.add(name)
+
+    def _check_metadata_files_exist_for_mcnp_models(self, paths: list[Path]) -> None:
+        for path in paths:
+            if path.suffix == ".mcnp" and not path.with_suffix(".metadata").exists():
+                raise GitronicsError(f"Metadata file not found for: {path}")
+
+    def _update_summary_data_with_all_files_info(
+        self, paths: list[Path], extra_metadata_fields: list[str] | None = None
+    ) -> None:
+        data = []
+        for path in paths:
+            relative_path = str(
+                path.relative_to(self.project_manager.project_root.absolute()).parent
+            )
+            entry = {
+                "Type": TYPE_BY_SUFFIX[path.suffix],
+                "Name": path.stem,
+                "Path": relative_path,
+            }
+            data.append(entry)
+            if extra_metadata_fields:
+                try:
+                    metadata = self.project_manager.get_metadata(path.stem)
+                except GitronicsError:
+                    metadata = {}
+                for metadata_field in extra_metadata_fields:
+                    entry[metadata_field] = metadata.get(metadata_field, "")
+
+        dataframe = pl.DataFrame(data).sort(["Type", "Path", "Name"])
+        self.summary_data.all_files_info = dataframe
+
+    def _check_envelope_structure(self, config: Config) -> None:
+        """Checks that the envelope structure is defined in the configuration and that
+        it exists."""
+        if not config.envelope_structure:
+            raise GitronicsError(
+                "Envelope structure is not defined in the configuration."
+            )
+        if config.envelope_structure not in self.project_manager.file_paths:
+            raise GitronicsError(
+                f"Envelope structure file {config.envelope_structure} not found "
+                "in the project."
+            )
+
+    def _check_envelopes(self, config: Config) -> None:
+        """Checks that, if there is an envelopes field, all the envelopes appear in the
+        envelope structure. Prints a warning if there are envelopes that do not appear
+        in the configuration."""
+        if not config.envelopes:
+            return
+
+        envelope_structure_path = self.project_manager.file_paths[
+            config.envelope_structure
+        ]
+        with open(envelope_structure_path, encoding="utf-8") as infile:
+            text = infile.read()
+        envelope_names_in_structure = set()
+        for line in text.splitlines():
+            placeholder_match = PLACEHOLDER_PAT.search(line)
+            if placeholder_match:
+                envelope_name = placeholder_match.group(1)
+                envelope_names_in_structure.add(envelope_name)
+
+        for envelope_name in config.envelopes.keys():
+            if envelope_name not in envelope_names_in_structure:
+                raise GitronicsError(
+                    f"Envelope {envelope_name} not found in the envelope structure."
+                )
+
+        empty_envelopes = envelope_names_in_structure.difference(
+            config.envelopes.keys()
+        )
+        if empty_envelopes:
+            logging.warning(
+                "There are empty envelopes in the structure not accounted for in the "
+                "configuration: %s",
+                empty_envelopes,
+            )
+
+    def _check_fillers(self, config: Config) -> None:
+        """Check that all the fillers exist and that their metadata includes the
+        necessary transformation."""
+        for envelope_name, filler_name in config.envelopes.items():
+            if not filler_name:
+                continue
+            if filler_name not in self.project_manager.file_paths:
+                raise GitronicsError(
+                    f"Filler file {filler_name} not found in the project."
+                )
+            metadata = self.project_manager.get_metadata(filler_name)
+            try:
+                metadata["transformations"][envelope_name]
+            except (KeyError, TypeError):
+                raise GitronicsError(
+                    f"Transformation for envelope {envelope_name} not found in filler"
+                    f" model {filler_name} metadata."
+                )
+
+    def _check_source(self, config: Config) -> None:
+        """Check that the source file exists (if defined)."""
+        if config.source:
+            self._check_file_exists(config.source, "Source")
+
+    def _check_tallies(self, config: Config) -> None:
+        """Check that the tally files exist (if defined)."""
+        if config.tallies:
+            for tally in config.tallies:
+                self._check_file_exists(tally, "Tally")
+
+    def _check_materials(self, config: Config) -> None:
+        """Check that the material files exist (if defined)."""
+        if config.materials:
+            for material in config.materials:
+                self._check_file_exists(material, "Material")
+
+    def _check_transforms(self, config: Config) -> None:
+        """Check that the transform files exist (if defined)."""
+        if config.transforms:
+            for transform in config.transforms:
+                self._check_file_exists(transform, "Transform")
+
+    def _check_file_exists(self, file_name: str, file_type: str) -> None:
+        """Generic helper to check if a file exists in the project."""
+        if file_name not in self.project_manager.file_paths:
+            raise GitronicsError(
+                f"{file_type} file {file_name} not found in the project."
+            )
+
+    def _trigger_warnings(self, config: Config) -> None:
+        if not config.source:
+            logging.warning("No source included in the configuration!")
+        if not config.materials or len(config.materials) == 0:
+            logging.warning("No materials included in the configuration!")
+
+    def _update_summary_data_with_config(self, config: Config) -> None:
+        """Adds to the summary_data attribute the information from the given
+        configuration. This data will be used to create the Excel summary."""
+        table_configuration_and_structure = [
+            {"Type": "Configuration", "Name": config.name},
+            {"Type": "Envelope Structure", "Name": config.envelope_structure},
+        ]
+
+        table_envelopes = []
+        if config.envelopes:
+            for envelope_name, filler_name in config.envelopes.items():
+                table_envelopes.append(
+                    {"Envelope": envelope_name, "Filler": filler_name}
+                )
+
+        table_data_files = []
+        if config.source:
+            table_data_files.append({"Type": "Source", "Name": config.source})
+        if config.tallies:
+            for tally in config.tallies:
+                table_data_files.append({"Type": "Tally", "Name": tally})
+        if config.materials:
+            for material in config.materials:
+                table_data_files.append({"Type": "Material", "Name": material})
+        if config.transforms:
+            for transform in config.transforms:
+                table_data_files.append({"Type": "Transform", "Name": transform})
+        self.summary_data.config_summaries[config.name] = ConfigSummaryTables(
+            pl.DataFrame(table_configuration_and_structure),
+            pl.DataFrame(table_envelopes),
+            pl.DataFrame(table_data_files),
+        )
+
+    def _write_excel_summary(self, write_path: Path) -> None:
+        with Workbook(write_path / "summary.xlsx") as workbook:
+            if self.summary_data.all_files_info is not None:
+                self.summary_data.all_files_info.write_excel(
+                    workbook,
+                    worksheet="All files",
+                    position=(0, 0),
+                    autofit=True,
+                    header_format={"bold": True},
+                )
+
+            for conf_name, tables in self.summary_data.config_summaries.items():
+                tables.configuration_and_structure.write_excel(
+                    workbook,
+                    worksheet=conf_name,
+                    position=(0, 0),
+                    autofit=True,
+                    header_format={"bold": True},
+                )
+                tables.envelopes.write_excel(
+                    workbook,
+                    worksheet=conf_name,
+                    position=(4, 0),
+                    autofit=True,
+                    header_format={"bold": True},
+                )
+                tables.data_files.write_excel(
+                    workbook,
+                    worksheet=conf_name,
+                    position=(
+                        4,
+                        tables.envelopes.width + 1,
+                    ),
+                    autofit=True,
+                    header_format={"bold": True},
+                )

gitronics/project_manager.py

@@ -0,0 +1,143 @@
+import re
+from functools import lru_cache
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+from gitronics.file_discovery import get_valid_file_paths
+from gitronics.helpers import Config, GitronicsError, ProjectParameters
+
+
+class ProjectManager:
+    """Handles the file paths, metadata and configurations of the project."""
+
+    def __init__(self, project_parameters: ProjectParameters) -> None:
+        self.parameters = project_parameters
+        self.project_root = project_parameters.root_folder_path
+        if not self.project_root.exists() or not self.project_root.is_dir():
+            raise GitronicsError(f"The directory {self.project_root} does not exist.")
+
+        self.file_paths = get_valid_file_paths(self.project_root)
+
+    def get_included_paths(self, config: Config) -> list[Path]:
+        paths: list[Path] = []
+        self._include_envelope_structure(paths, config)
+        self._include_fillers(paths, config)
+        self._include_source(paths, config)
+        self._include_tallies(paths, config)
+        self._include_materials(paths, config)
+        self._include_transforms(paths, config)
+        return paths
+
+    @lru_cache(maxsize=1000)
+    def get_metadata(self, name: str) -> dict[str, Any]:
+        if name not in self.file_paths:
+            raise GitronicsError(f"File {name} not found in the project.")
+
+        file_path = self.file_paths[name].with_suffix(".metadata")
+        if not file_path.exists():
+            raise GitronicsError(f"Metadata file not found for {name}.")
+
+        with open(file_path, encoding="utf-8") as infile:
+            metadata = yaml.safe_load(infile) or {}
+        return metadata
+
+    def get_transformation(self, filler_name: str, envelope_name: str) -> str | None:
+        metadata = self.get_metadata(filler_name)
+        transformation = metadata["transformations"][envelope_name]
+        assert isinstance(transformation, str) or transformation is None
+        return transformation
+
+    @lru_cache(maxsize=1000)
+    def get_universe_id(self, filler_name: str) -> int:
+        """Returns the universe ID of the filler model."""
+        filler_path = self.file_paths[filler_name]
+        with open(filler_path, encoding="utf-8") as infile:
+            for line in infile:
+                universe_match = re.match(r"^[^cC\$]*\s*[uU]\s*=\s*(\d+)", line)
+                if universe_match:
+                    return int(universe_match.group(1))
+        raise GitronicsError(f"Universe ID not found in filler model {filler_path}")
+
+    def read_configuration(self, configuration_name: str) -> Config:
+        if configuration_name not in self.file_paths:
+            raise GitronicsError(f"Configuration file {configuration_name} not found.")
+        conf_path = self.file_paths[configuration_name]
+
+        with open(conf_path, encoding="utf-8") as infile:
+            conf_dict = yaml.safe_load(infile)
+
+        configuration = Config(
+            name=configuration_name,
+            overrides=conf_dict.get("overrides"),
+            envelope_structure=conf_dict.get("envelope_structure"),
+            envelopes=conf_dict.get("envelopes", {}),
+            source=conf_dict.get("source"),
+            tallies=conf_dict.get("tallies"),
+            materials=conf_dict.get("materials"),
+            transforms=conf_dict.get("transformations"),
+        )
+
+        configuration = self._override_configuration(configuration)
+
+        return configuration
+
+    def _override_configuration(self, new_conf: Config) -> Config:
+        if not new_conf.overrides:
+            return new_conf
+
+        base = self.read_configuration(new_conf.overrides)
+
+        base.name = new_conf.name
+        if new_conf.envelope_structure:
+            base.envelope_structure = new_conf.envelope_structure
+        if new_conf.envelopes:
+            base.envelopes.update(new_conf.envelopes)
+        if new_conf.source:
+            base.source = new_conf.source
+        if isinstance(new_conf.tallies, list):
+            base.tallies = new_conf.tallies
+        if isinstance(new_conf.materials, list):
+            base.materials = new_conf.materials
+        if isinstance(new_conf.transforms, list):
+            base.transforms = new_conf.transforms
+
+        return base
+
+    def _include_envelope_structure(self, paths: list[Path], config: Config) -> None:
+        if config.envelope_structure in self.file_paths:
+            paths.append(self.file_paths[config.envelope_structure])
+
+    def _include_fillers(self, paths: list[Path], config: Config) -> None:
+        if not config.envelopes:
+            return
+        for filler in config.envelopes.values():
+            if not filler:
+                continue
+            path = self.file_paths[filler]
+            if path not in paths:
+                paths.append(path)
+
+    def _include_source(self, paths: list[Path], config: Config) -> None:
+        if not config.source:
+            return
+        paths.append(self.file_paths[config.source])
+
+    def _include_tallies(self, paths: list[Path], config: Config) -> None:
+        if not config.tallies:
+            return
+        for tally in config.tallies:
+            paths.append(self.file_paths[tally])
+
+    def _include_materials(self, paths: list[Path], config: Config) -> None:
+        if not config.materials:
+            return
+        for material in config.materials:
+            paths.append(self.file_paths[material])
+
+    def _include_transforms(self, paths: list[Path], config: Config) -> None:
+        if not config.transforms:
+            return
+        for transform in config.transforms:
+            paths.append(self.file_paths[transform])

gitronics-0.3.2.dist-info/METADATA

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: gitronics
+Version: 0.3.2
+Summary: Automatically build an MCNP from a set of files.
+Author-email: Alvaro Cubi <cubiric@hotmail.com>
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: pip>=25.2
+Requires-Dist: polars>=1.33.1
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: xlsxwriter>=3.2.9
+Description-Content-Type: text/markdown
+
+![Gitronics Logo](docs/source/_static/logo.png)
+
+# Gitronics
+ A tool to manage and automatically build an MCNP model from a set of files.
+
+Please check the online documentation for installation and how to use: https://gitronics.readthedocs.io/en/latest/

gitronics-0.3.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+gitronics/__init__.py,sha256=RJbJRMlfRce0st03MJErYubd_bOHHpSwQk8SSZfCBUg,151
+gitronics/compose_model.py,sha256=cKAnmFOhbH0Jww_kSTCPQLQgLV0iTAe1ICL7GZ5KhOU,1079
+gitronics/file_discovery.py,sha256=eXygfKz84KPPAvuhSMF96gLFDIm4LJrXiIgvwzifjy0,817
+gitronics/file_readers.py,sha256=Iw0ymQQLWlYT-pm1XSy6zpaIoYS5KOaS7czLGHIKk0A,4103
+gitronics/generate_model.py,sha256=LlNY-rYiETuW4pdRRbIJ7PIQKyvH3eJwzoLeB3jrSSM,4847
+gitronics/helpers.py,sha256=DDdGInYL7s8UkJE63pk-6ubLsgbEAHxaNE-Z4G_nAks,824
+gitronics/project_checker.py,sha256=V5KaBGrfX5lMzdA_X1QpvJTCHvOGDvHGFZPn0wdjxXs,11805
+gitronics/project_manager.py,sha256=-urvL_4OpNgABda_NJy1ExXOofUNjx-DTkjhwVtkk8o,5630
+gitronics-0.3.2.dist-info/METADATA,sha256=U5p4ciQW84FMWX0MAQr05KfJkwZ7rc6P9mFFvQbMptI,617
+gitronics-0.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+gitronics-0.3.2.dist-info/licenses/LICENSE,sha256=QhdjJIRvSVT27zTXcyBHxi2IOsHHJrIKouDEnzG_KL0,13969
+gitronics-0.3.2.dist-info/RECORD,,

gitronics-0.3.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

gitronics-0.3.2.dist-info/licenses/LICENSE

@@ -0,0 +1,157 @@
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
+EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Work:
+
+Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+In this Licence, the following terms have the following meaning:
+
+— ‘The Licence’: this Licence.
+
+— ‘The Original Work’: the work or software distributed or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
+
+— ‘Derivative Works’: the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
+
+— ‘The Work’: the Original Work or its Derivative Works.
+
+— ‘The Source Code’: the human-readable form of the Work which is the most convenient for people to study and modify.
+
+— ‘The Executable Code’: any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
+
+— ‘The Licensor’: the natural or legal person that distributes or communicates the Work under the Licence.
+
+— ‘Contributor(s)’: any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
+
+— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of the Work under the terms of the Licence.
+
+— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
+
+2. Scope of the rights granted by the Licence
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for the duration of copyright vested in the Original Work:
+
+— use the Work in any circumstance and for all usage,
+
+— reproduce the Work,
+
+— modify the Work, and make Derivative Works based upon the Work,
+
+— communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
+
+— distribute the Work or copies thereof,
+
+— lend and rent the Work or copies thereof,
+
+— sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations thereto.
+
+5. Obligations of the Licensee
+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work to carry prominent notices stating that the Work has been modified and the date of modification.
+Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless the Original Work is expressly distributed only under this version of the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the Work or Derivative Work that alter or restrict the terms of the Licence.
+Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done under the terms of this Compatible Licence. For the sake of this clause, ‘Compatible Licence’ refers to the licences listed in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
+Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available for as long as the Licensee continues to distribute or communicate the Work.
+Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or 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 copyright notice.
+6. Chain of Authorship
+The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contri­ butions to the Work, under the terms of this Licence.
+
+7. Disclaimer of Warranty
+The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work and may therefore contain defects or ‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
+
+9. Additional agreements
+While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or 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 the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+In case of any Distribution or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
+
+13. Miscellaneous
+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. New versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
+
+14. Jurisdiction
+Without prejudice to specific agreement between parties,
+
+— any litigation resulting from the interpretation of this License, arising between the European Union institutions, bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
+
+— any litigation arising between other parties and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
+
+15. Applicable Law
+Without prejudice to specific agreement between parties,
+
+— this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, resides or has his registered office,
+
+— this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside a European Union Member State.
+
+Appendix
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+— GNU General Public License (GPL) v. 2, v. 3
+
+— GNU Affero General Public License (AGPL) v. 3
+
+— Open Software License (OSL) v. 2.1, v. 3.0
+
+— Eclipse Public License (EPL) v. 1.0
+
+— CeCILL v. 2.0, v. 2.1
+
+— Mozilla Public Licence (MPL) v. 2
+
+— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+
+— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
+
+— European Union Public Licence (EUPL) v. 1.1, v. 1.2
+
+— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+)
+
+The European Commission may update this Appendix to later versions of the above licences without producing a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the covered Source Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new EUPL version.
+
+This website is not sponsored or endorsed by the European Commission or any other institution, body or agency of the European Union.
+
+Created by Javier Casares (legal) under license EUPL 1.2.