gitronics 0.3.2__tar.gz

gitronics-0.3.2/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish Python Package
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

gitronics-0.3.2/.gitignore

@@ -0,0 +1,9 @@
+*.pyc
+__pycache__/
+*.egg-info/
+src/_version.py
+.coverage
+.assembled
+docs/_build/
+make.bat
+Makefile

gitronics-0.3.2/.python-version

@@ -0,0 +1 @@
+3.13

gitronics-0.3.2/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.

gitronics-0.3.2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,6 @@
+![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/docs/source/conf.py

@@ -0,0 +1,33 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Gitronics'
+copyright = '2025, Alvaro Cubi'
+author = 'Alvaro Cubi'
+release = '1.4'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx.ext.autosectionlabel"]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = ["_static"]
+html_logo = "_static/logo.png"
+html_sidebars = {"**": []}
+html_theme_options = {
+    "secondary_sidebar_items": ["page-toc"],
+}

gitronics-0.3.2/docs/source/index.rst

@@ -0,0 +1,139 @@
+.. Gitronics documentation master file, created by
+   sphinx-quickstart on Mon Apr  7 19:01:49 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Gitronics documentation
+=======================
+
+Welcome to the Gironics documentation. Gitronics is a Python package that allows the
+modularization of MCNP models. It is designed to help users create and manage complex 
+MCNP models by breaking them down into smaller, single-responsibility files.
+
+Installation
+============
+
+To install Gitronics you can clone the repository and then install it in a Python 
+environment using pip.
+
+How to use
+==========
+
+Inside the Gitronics package there is a folder called *example_project*. This folder
+can serve as a template for your own projects as it contains a working example of a 
+MCNP model using Gitronics.
+
+Your project may have a different directory structure, it does not matter where each
+file is stored or how they are grouped, as long as the paths in the `build_model.py`
+script and the `project_summary.csv` are correctly set.
+
+Philosophy
+----------
+
+The philosophy behind Gitronics is to consider an MCNP reference model as a project 
+that contains several files representing the different data that would define a MCNP
+model like the geometry of a system, material definitions, particle sources, tallies, 
+etc.
+Then, according to a configuration file, Gitronics will automatically compile all the 
+different files into a single MCNP input file which will be referred as 
+`assembled.mcnp`.
+
+In Gitronics, there are 6 types of files:
+
+- Main input file: 
+   Can also be called envelope structure. This file contains the 
+   envelope cells that will be filled by universe models. In the case of a simple model
+   without universes, this file will contain the geometry of the system. It has the 
+   suffix `.mcnp`.
+- Universe model: 
+   This file contains the geometry of a MCNP universe which often 
+   represents a specific system. The project can contain many universe models, and not 
+   all of them may be needed for a specific configuration. They have the suffix `.mcnp`.
+- Data cards: 
+   These files contain the data cards that may be used in the MCNP input 
+   file. They can be used to define materials, sources, tallies, etc. They have the 
+   suffix `.mat`, `.source`, `.tally` or `transform`. Only a single `.source` file is 
+   allowed to be selected in a configuration.
+- Configuration files: 
+   Each of these files represent a specific configuration of the
+   project. They are used to select which files will be included in the final MCNP
+   input file. They are in YAML format.
+- Project summary: 
+   This file contains information about each of the other files of 
+   the project. It is needed to build the `assembled.mcnp`. 
+- Building script: 
+   This script is used to build the `assembled.mcnp` file. It is a 
+   Python file that makes use of the Gitronics package. It is called `build_model.py`.
+
+Main input file
+---------------
+
+This file contains the envelope cells that will be filled with universes models. To
+define a cell as an envelope, it must include a comment of the form `$ FILL = <name>`, 
+where `<name>` is the name of the envelope (e.g. `$ FILL = Equatorial Port 04`).
+
+Universe model
+--------------
+
+The file contains the geometry of a MCNP universe. There should be no title card at
+the beginning of the file. The cells should contain the `U = <universe id>` card that
+defines them as a universe.
+
+Data cards
+----------
+
+The file represents a data card or set of data cards that may be included in the MCNP
+model. Anything written after a blank line will not be considered.
+
+Configuration files
+-------------------
+
+A configuration file is a YAML file used to select which files will be included in the
+`assembled.mcnp` file. The fields in the configuration are filled with names of other
+files. These names are not the file name of the file but a given name that is defined in
+the project summary file.
+The configuration may contain any of the following fields:
+
+- overrides: 
+   This field can be filled with the name of another configuration file that 
+   will serve as default. Any other field filled will override the default value.
+- envelope_structure: 
+   The name of the main input file.
+- envelopes: 
+   Filled with a dict of the form:
+   ``{<envelope name>: {filler: <universe name>, transform: <transform>}}``. The envelope name
+   must be the same as the one used in the main input file. The transform is optional, 
+   and is a string that will be added after the ``FILL = 123`` card and therefore can be used
+   to define a transformation like in ``FILL = 123  10 10 10``.
+- source: 
+   The name of the source file. Only one source file is allowed.
+- tallies: 
+   A list of the names of the tally files that will be included in the MCNP 
+   model.
+- materials: 
+   A list of the names of the material files that will be included in the 
+   MCNP model.
+- transforms: 
+   A list of the names of the transform files that will be included in the
+   MCNP model.
+
+Project summary
+---------------
+
+It is a CSV file that can contain any information the user wants to add about the
+files. It is mandatory to include as the first two columns: *Name* and *Relative path*.
+Each row represents a file in the project. The *Name* column is the name that will be 
+used in the configuration file. The *Relative path* column is the path to the file 
+relative to the project root.
+
+Building script
+---------------
+
+The user should update the paths inside the script before running it. In the script, it
+is specified which configuration file will be used. Run the script to generated the 
+`assembled.mcnp` file.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+

gitronics-0.3.2/docs/source/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+pydata-sphinx-theme