Merge pull request #842 from idaholab/alpha-test-checkvalue

Implemented automated Type and Value Checking

Author: MicahGale

.github/workflows/main.yml

@@ -2,9 +2,9 @@ name: CI testing
 
 on: 
   pull_request:
-    branches: [develop, alpha-test-dev, alpha-test, minor-rel-dev]
+    branches: ["*dev*", alpha-test*]
   push: 
-     branches: [develop, main, alpha-test, minor-rel-dev]
+     branches: ["*dev*", main, alpha-test*]
 
 jobs:
   build:

.gitignore

@@ -21,6 +21,7 @@ doc/build/*
 .coverage
 .hypothesis/
 .idea/
+.vscode/
 .venv/
 .ipynb_checkpoints/
 montepy/_version.py

LICENSE

@@ -14,8 +14,33 @@ copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM,
+OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+##############################################################################
+Code from checkvalue.py from OpenMC was incorporated into montepy._check_value.py,
+and is licensed by the following:
+###############################################################################
+
+Copyright (c) 2014-2025 Massachusetts Institute of Technology, UChicago Argonne
+LLC, and OpenMC contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

benchmark/benchmark_big_model.py

@@ -7,7 +7,7 @@
 
 import montepy
 
-FAIL_THRESHOLD = 40
+FAIL_THRESHOLD = 90
 MEMORY_FRACTION = 0.50
 
 starting_mem = tracemalloc.get_traced_memory()[0]

doc/source/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

doc/source/api/LICENSE

@@ -0,0 +1 @@
+../LICENSE

doc/source/api/modules.rst

@@ -171,9 +171,11 @@ Universal Utilities and constants
 .. toctree::
    :maxdepth: 1
 
+   montepy._check_value
    montepy.constants
    montepy.exceptions
    montepy.utilities
+   montepy.types
 
 
 Object Builders

doc/source/api/montepy._check_value.rst

@@ -0,0 +1,9 @@
+montepy._check_value module
+===========================
+
+
+.. automodule:: montepy._check_value
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:

doc/source/api/montepy.types.rst

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

doc/source/api/montepy.utilities.rst

@@ -5,5 +5,7 @@ montepy.utilities module
 .. automodule:: montepy.utilities
    :members:
    :inherited-members:
+   :imported-members:
+   :exclude-members: Integral, Iterable, Real, Callable
    :undoc-members:
    :show-inheritance: