Support Spheres #877

tjlaboss · 2026-01-13T21:23:50Z

Pull Request Checklist for MontePy

Description

Add object support for S, SX, SY, SZ, SO, similar to the cylinder and plane support.
Minor surface infrastructure updates

Fixes #876 (issue number)

General Checklist

I have performed a self-review of my own code.
The code follows the standards outlined in the development documentation.
I have formatted my code with black version 25.
I have added tests that prove my fix is effective or that my feature works (if applicable).

LLM Disclosure

Were any large language models (LLM or "AI") used in to generate any of this code?

Yes
- Model(s) used:
No

Documentation Checklist

I have documented all added classes and methods.

Additional Notes for Reviewers

Ensure that:

This PR fully addresses and resolves the referenced issue(s).
The submitted code is consistent with the merge checklist outlined here.
The PR covers all relevant aspects according to the development guidelines.
100% coverage of the patch is achieved, or justification for a variance is given.

Discussion

Spheres aren't candidates for periodic surfaces. I deleted duplicate surface checking related to that: please review carefully. There is a lot of copypasta for surface infrastructure that would be candidates for kicking up the Surface class or some other intermediate class.

📚 Documentation preview 📚: https://montepy--877.org.readthedocs.build/en/877/

tjlaboss · 2026-01-13T23:59:51Z

I got the coverage up enough to pass, but think that .find_duplicate_surfaces() should be reevaluated in the future (#878).

MicahGale · 2026-01-14T13:49:22Z

I got the coverage up enough to pass, but think that .find_duplicate_surfaces() should be reevaluated in the future (#878).

I'm not going to merge such a big untested function. Before #878 you could just return an empty list.

MicahGale

This is going to be fun to merge into minor_rel_dev

montepy/surfaces/__init__.py

montepy/surfaces/general_sphere.py

montepy/surfaces/sphere_at_origin.py

montepy/surfaces/sphere_on_axis.py

montepy/surfaces/surface_builder.py

tests/test_surfaces.py

Co-authored-by: Micah Gale <mgale@montepy.org>

MicahGale

Changes should be marked with the version the objects were added.

Also patch coverage is < 100%. I think you need to look into the validation testing some more.

montepy/surfaces/__init__.py

montepy/surfaces/general_sphere.py

MicahGale · 2026-01-14T19:45:13Z

montepy/surfaces/sphere_on_axis.py

+        if self.location is None:
+            raise IllegalState(f"Surface: {self.number} does not have a location set.")
+
+    def find_duplicate_surfaces(self, surfaces, tolerance):


add a # pragma: no cover

Not sure why these IllegalState paths aren't getting tested in test_surfaces.py

Sorry I mean for find_duplicate_surfaces, not for the IllegalState ones.

tjlaboss · 2026-01-15T15:33:50Z

Ready for re-review.

Changed in version 9.0: The versionadded directive was renamed to version-added. The previous name is retained as an alias.

MicahGale

Gotta have more coverage.

MicahGale · 2026-01-17T01:41:28Z

montepy/surfaces/sphere_on_axis.py

+        if self.location is None:
+            raise IllegalState(f"Surface: {self.number} does not have a location set.")
+
+    def find_duplicate_surfaces(self, surfaces, tolerance):


Sorry I mean for find_duplicate_surfaces, not for the IllegalState ones.

MicahGale · 2026-01-17T01:48:35Z

tests/test_surfaces.py

+    with pytest.raises(IllegalState):
+        surf.format_for_mcnp_input(vers)
+    # sphere on axis
+    surf = SphereOnAxis(number=5)


All of these are getting caught by the parent class validate which requires a set surface_type. After the first validate call set surface_type.

tjlaboss added 11 commits January 13, 2026 14:19

Add SphereOnAxis

52fd292

Add GeneralSphere

1e3f752

Add SphereAtOrigin

24be846

Touch up sphere files

d33847a

Add spheres to surface builder

ddd19fa

format_for_mcnp_input() type hinting

f300c46

Debug general sphere

639def3

Test sphere constant setter

6875e8a

Test the new sphere classes

145eeae

Update CHANGELOG

25db4d3

Touch up GeneralSphere some more

8a791ec

tjlaboss changed the title ~~Baller~~ Support Spheres Jan 13, 2026

tjlaboss requested a review from MicahGale January 13, 2026 21:24

tjlaboss added 6 commits January 13, 2026 16:13

A sphere cannot be a periodic surface of a plane.

36ce708

Restore sphere periodic check

6f1d999

Format with black

d7e2271

Increase sphere code coverage

1652be1

test_surfaces.py cleanup

2c6eaf5

Merge branch 'develop' into baller

8f71eb4

MicahGale requested changes Jan 14, 2026

View reviewed changes

tjlaboss and others added 7 commits January 14, 2026 12:10

Update montepy/surfaces/general_sphere.py

63fcc47

Co-authored-by: Micah Gale <mgale@montepy.org>

Update montepy/surfaces/general_sphere.py

58fc726

Co-authored-by: Micah Gale <mgale@montepy.org>

Remove copypasted duplicate surface finding

a8d4bf5

Update surfaces/__init__.py

cb1556e

surface_type does not need to be passed here

5625055

mislabeled test

17864bc

Add spheres to doc toc

fea49b0

MicahGale requested changes Jan 14, 2026

View reviewed changes

tjlaboss requested a review from MicahGale January 14, 2026 19:51

tjlaboss added 3 commits January 14, 2026 12:53

Spheres will be added to version 1.3.0

cfd1431

pragma: no cover

31e9b92

Increase sphere coverage

4bf6df3

tjlaboss added 2 commits January 15, 2026 08:38

Corrected version-added directives

ea0fb6f

Changed in version 9.0: The versionadded directive was renamed to version-added. The previous name is retained as an alias.

versionadded directive not renamed just yet

ed6f05d

tjlaboss enabled auto-merge (squash) January 15, 2026 16:12

MicahGale requested changes Jan 17, 2026

View reviewed changes

Support Spheres #877

Are you sure you want to change the base?

Support Spheres #877

Uh oh!

Conversation

tjlaboss commented Jan 13, 2026 • edited by MicahGale Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist for MontePy

Description

General Checklist

LLM Disclosure

Documentation Checklist

Additional Notes for Reviewers

Discussion

Uh oh!

tjlaboss commented Jan 13, 2026

Uh oh!

MicahGale commented Jan 14, 2026

Uh oh!

MicahGale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MicahGale left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MicahGale Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

tjlaboss Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

MicahGale Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

tjlaboss commented Jan 15, 2026

Uh oh!

MicahGale left a comment

Choose a reason for hiding this comment

Uh oh!

MicahGale Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

MicahGale Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tjlaboss commented Jan 13, 2026 •

edited by MicahGale

Loading