Mat redesign

.github/scripts/check_version.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+
+import argparse
+import re
+import sys
+from setuptools_scm import get_version
+
+parser = argparse.ArgumentParser()
+parser.add_argument("-a", "--alpha", action="store_true")
+DEPLOY_VERSION = r"\d+\.\d+\.\d+"
+ALPHA_VERSION = DEPLOY_VERSION + r"a\d+"
+args = parser.parse_args()
+if args.alpha:
+    print("checking alpha release")
+    parser = ALPHA_VERSION
+else:
+    print("checking Final release.")
+    parser = DEPLOY_VERSION
+
+version = get_version()
+print(f"version = {version}")
+if not re.fullmatch(parser, version):
+    exit(1)
+exit(0)

.github/workflows/deploy-alpha.yml

@@ -0,0 +1,107 @@
+name: Deploy
+
+on: 
+  push:
+    branches: [alpha-test]
+
+
+jobs:
+  last-minute-test:
+    runs-on: ubuntu-latest    
+    steps:
+      - uses: actions/checkout@v4
+      - name: set up python  3.12
+        uses: actions/setup-python@v5
+        with: 
+          python-version: 3.12
+      - run: pip install . montepy[develop]
+      - run: python -m pytest
+
+  build-packages:
+    name: Build, sign, and release packages on github
+    runs-on: ubuntu-latest
+    needs: [last-minute-test]
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+    env:
+      GH_TOKEN: ${{ github.token }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: set up python  3.12
+        uses: actions/setup-python@v5
+        with: 
+          python-version: 3.12
+      - run: pip install . montepy[build]
+      - name: Get Version
+        id: get_version
+        run: echo "version=`python -m setuptools_scm`" >> $GITHUB_OUTPUT
+      - name: Verify that this is a non-dev alpha release
+        run: .github/scripts/check_version.py --alpha 
+      - run: python -m build .
+      - name: Sign the dists with Sigstore
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: v${{ steps.get_version.outputs.version }}
+          name: Release ${{ steps.get_version.outputs.version }}
+          draft: true
+      - run: >-
+          gh release upload
+          'v${{ steps.get_version.outputs.version }}' dist/**
+          --repo '${{ github.repository }}'
+      - uses: actions/upload-artifact@v4
+        with: 
+           name: build
+           path: |
+               dist/*.tar.gz 
+               dist/*.whl
+
+
+  deploy-test-pypi: 
+    environment:
+      name: test-pypi
+      url: https://test.pypi.org/p/montepy  # Replace <package-name> with your PyPI project name
+    needs: [build-packages]
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  deploy-pypi: 
+    environment:
+      name: pypi
+      url: https://pypi.org/p/montepy  # Replace <package-name> with your PyPI project name
+    needs: [deploy-pages, deploy-test-pypi, build-packages]
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+
+
+

.github/workflows/deploy.yml

@@ -62,7 +62,7 @@ jobs:
         id: get_version
         run: echo "version=`python -m setuptools_scm`" >> $GITHUB_OUTPUT
       - name: Verify that this is a non-dev release
-        run: .github/scripts/check_version.sh ${{ steps.get_version.outputs.version }}
+        run: .github/scripts/check_version.py
       - run: python -m build .
       - name: Sign the dists with Sigstore
         uses: sigstore/[email protected]

.gitignore

@@ -17,3 +17,8 @@ doc/build/*
 .idea/
 .ipynb_checkpoints/
 montepy/_version.py
+
+# various testing results
+htmlcov
+.hypothesis
+.mutmut-cache

benchmark/benchmark_big_model.py

@@ -17,7 +17,9 @@
 print(f"Memory usage report: {tracemalloc.get_traced_memory()[0]/1024/1024} MB")
 del problem
 gc.collect()
-print(f"Memory usage report after GC: {tracemalloc.get_traced_memory()[0]/1024/1024} MB")
+print(
+    f"Memory usage report after GC: {tracemalloc.get_traced_memory()[0]/1024/1024} MB"
+)
 
 if (stop - start) > FAIL_THRESHOLD:
     raise RuntimeError(

demo/Pin_cell.ipynb

@@ -9,6 +9,7 @@
    "source": [
     "import montepy\n",
     "import os\n",
+    "\n",
     "montepy.__version__"
    ]
   },
@@ -95,7 +96,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#make folder\n",
+    "# make folder\n",
     "os.mkdir(\"parametric\")\n",
     "\n",
     "fuel_wall = problem.surfaces[1]\n",

doc/source/_test_for_missing_docs.py

@@ -9,6 +9,7 @@
     "_version.py",
     "__main__.py",
     "_cell_data_control.py",
+    "_singleton.py"
 }
 
 base = os.path.join("..", "..")

doc/source/api/montepy.data_inputs.nuclide.rst

@@ -0,0 +1,10 @@
+montepy.data_inputs.nuclide module
+==================================
+
+
+.. automodule:: montepy.data_inputs.nuclide
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:
+

doc/source/api/montepy.data_inputs.rst

@@ -23,6 +23,7 @@ montepy.data\_inputs package
    montepy.data_inputs.lattice_input
    montepy.data_inputs.material
    montepy.data_inputs.material_component
+   montepy.data_inputs.nuclide
    montepy.data_inputs.mode
    montepy.data_inputs.thermal_scattering
    montepy.data_inputs.transform

doc/source/api/montepy.input_parser.material_parser.rst

@@ -0,0 +1,9 @@
+montepy.input\_parser.material\_parser module
+==============================================
+
+
+.. automodule:: montepy.input_parser.material_parser
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:

doc/source/api/montepy.input_parser.rst

@@ -17,12 +17,14 @@ montepy.input\_parser package
    montepy.input_parser.input_file
    montepy.input_parser.input_reader
    montepy.input_parser.input_syntax_reader
+   montepy.input_parser.material_parser
    montepy.input_parser.mcnp_input
    montepy.input_parser.parser_base
    montepy.input_parser.read_parser
    montepy.input_parser.shortcuts
    montepy.input_parser.surface_parser
    montepy.input_parser.syntax_node
    montepy.input_parser.tally_parser
+   montepy.input_parser.tally_seg_parser
    montepy.input_parser.thermal_parser
    montepy.input_parser.tokens

doc/source/api/montepy.input_parser.tally_seg_parser.rst

@@ -0,0 +1,9 @@
+montepy.input\_parser.tally\_seg\_parser module
+===============================================
+
+
+.. automodule:: montepy.input_parser.tally_seg_parser
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:

doc/source/changelog.rst

@@ -2,6 +2,40 @@
 MontePy Changelog
 *****************
 
+1.0.0 releases
+==============
+
+#Next Version#
+--------------
+* Redesigned how Materials hold Material_Components. See :ref:`migrate 0 1` (:pull:`507`). 
+
+**Breaking Changes**
+
+* Removed ``Material.material_components``. See :ref:`migrate 0 1` (:pull:`507`).
+
+**Deprecated code Removed**
+
+* ``montepy.Cell.geometry_logic_string``
+* ``montepy.data_inputs.cell_modifier.CellModifier.has_changed_print_style``
+* ``montepy.data_inputs.data_input.DataInputAbstract``
+
+  * ``class_prefix``
+  * ``has_number``
+  * ``has_classifier``
+
+* ``montepy.input_parser.mcnp_input.Card``
+* ``montepy.input_parser.mcnp_input.ReadCard``
+* ``montepy.input_parser.mcnp_input.Input.words``
+* ``montepy.input_parser.mcnp_input.Comment``
+* ``montepy.input_parser.mcnp_input.parse_card_shortcuts``
+* ``montepy.mcnp_object.MCNP_Object``
+
+  * ``wrap_words_for_mcnp``
+  * ``compress_repeat_values``
+  * ``compress_jump_values``
+  * ``words``
+  * ``allowed_keywords``
+
 0.5 releases
 ============
 
@@ -47,7 +81,7 @@ MontePy Changelog
 ============
 
 0.4.1
---------------
+----------------
 
 **Features Added**
 

doc/source/conf.py

@@ -37,9 +37,10 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.extlinks",
     "sphinx.ext.doctest",
+    "sphinx_autodoc_typehints",
     "sphinx_sitemap",
     "sphinx_favicon",
-    "sphinx_copybutton"
+    "sphinx_copybutton",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -60,6 +61,12 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
+# autodoc
+autodoc_typehints = "both"
+typehints_use_signature = True
+typehints_use_signature_return = True
+autodoc_typehints_description_target = "all"
+autodoc_member_order = "groupwise"
 # Display the version
 display_version = True
 
@@ -68,16 +75,23 @@
     "https://mcnp.lanl.gov/pdf_files/TechReport_2022_LANL_LA-UR-22-30006"
     "Rev.1_KuleszaAdamsEtAl.pdf"
 )
+UM631 = "https://www.osti.gov/servlets/purl/2372634"
 UM62 = (
     "https://mcnp.lanl.gov/pdf_files/TechReport_2017_LANL_LA-UR-17-29981"
     "_WernerArmstrongEtAl.pdf"
 )
 extlinks = {
     # MCNP 6.3 User's Manual
-    "manual63sec": (UM63 + "#section.%s", "MCNP 6.3 manual § %s"),
-    "manual63": (UM63 + "#subsection.%s", "MCNP 6.3 manual § %s"),
-    "manual63part": (UM63 + "#part.%s", "MCNP 6.3 manual § %s"),
-    "manual63chapter": (UM63 + "#chapter.%s", "MCNP 6.3 manual § %s"),
+    "manual63sec": (UM63 + "#section.%s", "MCNP 6.3.0 manual § %s"),
+    "manual63": (UM63 + "#subsection.%s", "MCNP 6.3.0 manual § %s"),
+    "manual63part": (UM63 + "#part.%s", "MCNP 6.3.0 manual part %s"),
+    "manual63chapter": (UM63 + "#chapter.%s", "MCNP 6.3.0 manual Ch. %s"),
+    # MCNP 6.3.1 User's Manual
+    "manual631sec": (UM631 + "#section.%s", "MCNP 6.3.1 manual § %s"),
+    "manual631": (UM631 + "#subsection.%s", "MCNP 6.3.1 manual § %s"),
+    "manual631part": (UM631 + "#part.%s", "MCNP 6.3.1 manual part %s"),
+    "manual631chapter": (UM631 + "#chapter.%s", "MCNP 6.3.1 manual Ch. %s"),
+    # MCNP 6.2 User's manual
     "manual62": (UM62 + "#page=%s", "MCNP 6.2 manual p. %s"),
     "issue": ("https://github.com/idaholab/MontePy/issues/%s", "#%s"),
     "pull": ("https://github.com/idaholab/MontePy/pull/%s", "#%s"),