- Move more modules to private modules

Kankelborg-Group · Nov 17, 2020 · ae4c471 · ae4c471
1 parent d17a052
commit ae4c471
Show file tree

Hide file tree

Showing 14 changed files with 18 additions and 15 deletions.
diff --git a/kgpy/test_matrix.py → kgpy/_matrix_test.py b/kgpy/test_matrix.py → kgpy/_matrix_test.py
diff --git a/kgpy/test_obs.py → kgpy/_obs_test.py b/kgpy/test_obs.py → kgpy/_obs_test.py
diff --git a/kgpy/test_rebin.py → kgpy/_rebin_test.py b/kgpy/test_rebin.py → kgpy/_rebin_test.py
diff --git a/kgpy/test_vector.py → kgpy/_vector_test.py b/kgpy/test_vector.py → kgpy/_vector_test.py
diff --git a/kgpy/img/test_spikes.py → kgpy/img/_spikes_test.py b/kgpy/img/test_spikes.py → kgpy/img/_spikes_test.py
diff --git a/kgpy/observatories/aia/test_aia.py → kgpy/observatories/aia/_aia_test.py b/kgpy/observatories/aia/test_aia.py → kgpy/observatories/aia/_aia_test.py
@@ -5,7 +5,7 @@
 import astropy.units as u
 import astropy.time
 import kgpy.plot
-import kgpy.test_obs
+import kgpy._obs_test
 from . import AIA
 
 
@@ -18,7 +18,7 @@ def obs_test() -> AIA:
     return AIA.from_time_range(time_start, time_end, download_path, channels=channels)
 
 
-class TestAIA(kgpy.test_obs.TestObs):
+class TestAIA(kgpy._obs_test.TestObs):
 
     def test_from_time_range(self,  obs_test: AIA):
         # with capsys.disabled():

diff --git a/kgpy/optics/_system.py b/kgpy/optics/_system.py
@@ -26,13 +26,16 @@ class System(
     mixin.Broadcastable,
     mixin.Named,
 ):
-    object_surface: Surface = dataclasses.field(default_factory=Surface)
-    surfaces: SurfaceList = dataclasses.field(default_factory=SurfaceList)
-    wavelengths: typ.Optional[u.Quantity] = None
-    pupil_samples: typ.Union[int, typ.Tuple[int, int]] = 3
-    pupil_margin: u.Quantity = 1 * u.um
-    field_samples: typ.Union[int, typ.Tuple[int, int]] = 3
-    field_margin: u.Quantity = 1 * u.nrad
+    """
+    Model of an optical system.
+    """
+    object_surface: Surface = dataclasses.field(default_factory=Surface)        #: Surface representing light source
+    surfaces: SurfaceList = dataclasses.field(default_factory=SurfaceList)      #: All surfaces in the optical system
+    wavelengths: typ.Optional[u.Quantity] = None    #: Source wavelengths
+    pupil_samples: typ.Union[int, typ.Tuple[int, int]] = 3      #: Number of samples across the pupil for each axis x, y
+    pupil_margin: u.Quantity = 1 * u.um     #: Margin between edge of pupil and nearest ray
+    field_samples: typ.Union[int, typ.Tuple[int, int]] = 3      #: Number of samples across the field for each axis x, y
+    field_margin: u.Quantity = 1 * u.nrad       #: Margin between edge of field and nearest ray
     # baffle_positions: typ.Optional[typ.List[transform.rigid.Transform]] = None
 
     def __post_init__(self):

diff --git a/kgpy/optimization/minimization/__init__.py b/kgpy/optimization/minimization/__init__.py
@@ -1,2 +1,2 @@
-from .golden_section_search import golden_section_search
-from .coordinate_descent import coordinate_descent
+from ._golden_section_search import golden_section_search
+from ._coordinate_descent import coordinate_descent
diff --git a/...zation/minimization/coordinate_descent.py → ...ation/minimization/_coordinate_descent.py b/...zation/minimization/coordinate_descent.py → ...ation/minimization/_coordinate_descent.py
diff --git a/...ion/minimization/golden_section_search.py → ...on/minimization/_golden_section_search.py b/...ion/minimization/golden_section_search.py → ...on/minimization/_golden_section_search.py
diff --git a/kgpy/plot/test_cube_slicer.py → kgpy/plot/_cube_slicer_test.py b/kgpy/plot/test_cube_slicer.py → kgpy/plot/_cube_slicer_test.py
diff --git a/kgpy/plot/test_image_slicer.py → kgpy/plot/_image_slicer_test.py b/kgpy/plot/test_image_slicer.py → kgpy/plot/_image_slicer_test.py
diff --git a/kgpy/transform/rigid/test_tilt.py → kgpy/transform/rigid/_tilt_test.py b/kgpy/transform/rigid/test_tilt.py → kgpy/transform/rigid/_tilt_test.py
@@ -3,7 +3,7 @@
 import astropy.units as u
 from kgpy import vector
 from kgpy.vector import x_hat, y_hat, z_hat
-from . import tilt
+from . import _tilt
 
 
 class TestTiltX:
@@ -17,7 +17,7 @@ class TestTiltX:
         ],
     )
     def test__call__(self, vec: u.Quantity, angle: u.Quantity, vec_out: u.Quantity):
-        assert np.isclose(tilt.TiltX(angle)(vec), vec_out).all()
+        assert np.isclose(_tilt.TiltX(angle)(vec), vec_out).all()
 
 
 class TestTiltY:
@@ -31,7 +31,7 @@ class TestTiltY:
         ],
     )
     def test__call__(self, vec: u.Quantity, angle: u.Quantity, vec_out: u.Quantity):
-        assert np.isclose(tilt.TiltY(angle)(vec), vec_out).all()
+        assert np.isclose(_tilt.TiltY(angle)(vec), vec_out).all()
 
 
 class TestTiltZ:
@@ -45,4 +45,4 @@ class TestTiltZ:
         ],
     )
     def test__call__(self, vec: u.Quantity, angle: u.Quantity, vec_out: u.Quantity):
-        assert np.isclose(tilt.TiltZ(angle)(vec), vec_out).all()
+        assert np.isclose(_tilt.TiltZ(angle)(vec), vec_out).all()
diff --git a/kgpy/transform/rigid/test_transform_list.py → kgpy/transform/rigid/_transform_list_test.py b/kgpy/transform/rigid/test_transform_list.py → kgpy/transform/rigid/_transform_list_test.py