Moved the apertures module to a subpackage (#144)

Author: roytsmart

optika/apertures/__init__.py

@@ -0,0 +1,35 @@
+"""
+Apertures that can be used by optical surfaces to block a portion of the beam.
+"""
+
+from ._apertures import (
+    AbstractAperture,
+    CircularAperture,
+    CircularSectorAperture,
+    EllipticalAperture,
+    AbstractPolygonalAperture,
+    PolygonalAperture,
+    RectangularAperture,
+    AbstractRegularPolygonalAperture,
+    RegularPolygonalAperture,
+    AbstractOctagonalAperture,
+    OctagonalAperture,
+    AbstractIsoscelesTrapezoidalAperture,
+    IsoscelesTrapezoidalAperture,
+)
+
+__all__ = [
+    "AbstractAperture",
+    "CircularAperture",
+    "CircularSectorAperture",
+    "EllipticalAperture",
+    "AbstractPolygonalAperture",
+    "PolygonalAperture",
+    "RectangularAperture",
+    "AbstractRegularPolygonalAperture",
+    "RegularPolygonalAperture",
+    "AbstractOctagonalAperture",
+    "OctagonalAperture",
+    "AbstractIsoscelesTrapezoidalAperture",
+    "IsoscelesTrapezoidalAperture",
+]

optika/apertures.py optika/apertures/_apertures.pyoptika/apertures.py renamed to optika/apertures/_apertures.py

@@ -1,7 +1,3 @@
-"""
-Apertures that can be used by optical surfaces to block a portion of the beam.
-"""
-
 import abc
 import dataclasses
 import numpy as np
@@ -20,7 +16,9 @@
     "EllipticalAperture",
     "AbstractPolygonalAperture",
     "PolygonalAperture",
+    "RectangularAperture",
     "AbstractRegularPolygonalAperture",
+    "RegularPolygonalAperture",
     "AbstractOctagonalAperture",
     "OctagonalAperture",
     "AbstractIsoscelesTrapezoidalAperture",

optika/_tests/test_apertures.py optika/apertures/_apertures_test.pyoptika/_tests/test_apertures.py renamed to optika/apertures/_apertures_test.py

@@ -5,7 +5,7 @@
 import named_arrays as na
 import optika
 import optika.rays._tests.test_ray_vectors
-from . import test_mixins
+from .._tests import test_mixins
 
 
 active_parameterization = [