Restructure package (#203)

Author: mcw92

artist/__init__.py

@@ -1,18 +1,6 @@
-"""Bundle ``ARTIST`` as a package."""
+"""Top-level package for ARTIST."""
 
 import os
 
-from . import core, data_parser, field, scenario, scene, util
-
 ARTIST_ROOT = f"{os.sep}".join(__file__.split(os.sep)[:-2])
 """Reference to the root directory of ``ARTIST``."""
-
-__all__ = [
-    "core",
-    "data_parser",
-    "field",
-    "scenario",
-    "scene",
-    "util",
-    "ARTIST_ROOT",
-]

artist/core/__init__.py

@@ -1,31 +1,29 @@
-"""Bundle all classes that represent physical objects in ``ARTIST``."""
-
-from artist.field.actuators import Actuators
-from artist.field.actuators_ideal import IdealActuators
-from artist.field.actuators_linear import LinearActuators
-from artist.field.heliostat_field import HeliostatField
-from artist.field.heliostat_group import HeliostatGroup
-from artist.field.heliostat_group_rigid_body import HeliostatGroupRigidBody
-from artist.field.kinematics import Kinematics
-from artist.field.kinematics_rigid_body import RigidBody
-from artist.field.solar_tower import SolarTower
-from artist.field.surface import Surface
-from artist.field.tower_target_areas import TowerTargetAreas
-from artist.field.tower_target_areas_cylindrical import TowerTargetAreasCylindrical
-from artist.field.tower_target_areas_planar import TowerTargetAreasPlanar
+from .actuators import Actuators
+from .actuators_ideal import IdealActuators
+from .actuators_linear import LinearActuators
+from .heliostat_field import HeliostatField
+from .heliostat_group import HeliostatGroup
+from .heliostat_group_rigid_body import HeliostatGroupRigidBody
+from .kinematics import Kinematics
+from .kinematics_rigid_body import RigidBody
+from .solar_tower import SolarTower
+from .surface import Surface
+from .tower_target_areas import TowerTargetAreas
+from .tower_target_areas_cylindrical import TowerTargetAreasCylindrical
+from .tower_target_areas_planar import TowerTargetAreasPlanar
 
 __all__ = [
+    "HeliostatField",
     "Actuators",
-    "IdealActuators",
     "LinearActuators",
-    "Surface",
-    "HeliostatField",
+    "IdealActuators",
     "HeliostatGroup",
     "HeliostatGroupRigidBody",
-    "TowerTargetAreas",
-    "TowerTargetAreasPlanar",
-    "TowerTargetAreasCylindrical",
     "Kinematics",
     "RigidBody",
     "SolarTower",
+    "TowerTargetAreas",
+    "TowerTargetAreasPlanar",
+    "TowerTargetAreasCylindrical",
+    "Surface",
 ]

artist/core/core_utils.py

@@ -1,6 +1,6 @@
 import torch
 
-from artist.util.environment_setup import get_device
+from artist.util.env import get_device
 
 
 class Actuators(torch.nn.Module):
@@ -11,16 +11,18 @@ class Actuators(torch.nn.Module):
     ----------
     non_optimizable_parameters : torch.Tensor
         The non-optimizable actuator parameters, describing actuator geometry.
-        Tensor of shape [number_of_heliostats, 7, 2] for linear actuators or [number_of_heliostats, 4, 2] for ideal actuators.
+        Shape is ``[number_of_heliostats, 7, 2]`` for linear actuators
+        or ``[number_of_heliostats, 4, 2]`` for ideal actuators.
     optimizable_parameters : torch.Tensor
         The two optimizable actuator parameters, describing the initial actuator configuration.
-        Tensor of shape [number_of_heliostats, 2, 2] for linear actuators or [] for ideal actuators.
+        Shape is ``[number_of_heliostats, 2, 2]`` for linear actuators or ``[]`` for ideal actuators.
     active_non_optimizable_parameters : torch.Tensor
         Active non-optimizable geometry parameters.
-        Tensor of shape [number_of_active_heliostats, 7, 2] for linear actuators or [number_of_active_heliostats, 4, 2] for ideal actuators.
+        Shape is ``[number_of_active_heliostats, 7, 2]`` for linear actuators
+        or ``[number_of_active_heliostats, 4, 2]`` for ideal actuators.
     active_optimizable_parameters : torch.Tensor
         Active optimizable parameters.
-        Tensor of shape [number_of_active_heliostats, 2, 2] for linear actuators or [] for ideal actuators.
+        Shape is ``[number_of_active_heliostats, 2, 2]`` for linear actuators or ``[]`` for ideal actuators.
 
     Methods
     -------
@@ -51,10 +53,12 @@ def __init__(
         ----------
         non_optimizable_parameters : torch.Tensor
             The non-optimizable actuator parameters, describing actuator geometry.
-            Tensor of shape [number_of_heliostats, 7, 2] for linear actuators or [number_of_heliostats, 4, 2] for ideal actuators.
+            Shape is ``[number_of_heliostats, 7, 2]`` for linear actuators
+            or ``[number_of_heliostats, 4, 2]`` for ideal actuators.
         optimizable_parameters : torch.Tensor
             The two optimizable actuator parameters, describing the initial actuator configuration.
-            Tensor of shape [number_of_heliostats, 2, 2] for linear actuators or [] for ideal actuators (default is torch.Tensor([])).
+            Shape is ``[number_of_heliostats, 2, 2]`` for linear actuators
+            or ``[]`` for ideal actuators (default is ``torch.tensor([])``).
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -82,7 +86,7 @@ def motor_positions_to_angles(
         ----------
         motor_positions : torch.Tensor
             The motor positions.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -105,7 +109,7 @@ def angles_to_motor_positions(
         ----------
         angles : torch.Tensor
             The joint angles.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -128,7 +132,7 @@ def forward(
         ----------
         motor_positions : torch.Tensor
             The motor positions to be converted to joint angles.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -138,7 +142,7 @@ def forward(
         -------
         torch.Tensor
             The joint angles.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
 
         """
         device = get_device(device=device)

artist/data_parser/__init__.py

@@ -11,16 +11,16 @@ class IdealActuators(Actuators):
     ----------
     non_optimizable_parameters : torch.Tensor
         The four non-optimizable actuator parameters, describing actuator geometry.
-        Tensor of shape [number_of_heliostats, 4, 2].
+        Shape is ``[number_of_heliostats, 4, 2]``.
     optimizable_parameters : torch.Tensor
         The ideal actuators do not have optimizable parameters, this tensor is therefore empty.
-        Tensor of shape [].
+        Shape is ``[]``.
     active_non_optimizable_parameters : torch.Tensor
         Active non-optimizable geometry parameters.
-        Tensor of shape [number_of_active_heliostats, 4, 2].
+        Shape is ``[number_of_active_heliostats, 4, 2]``.
     active_optimizable_parameters : torch.Tensor
         The ideal actuators do not have optimizable parameters, this tensor is therefore empty.
-        Tensor of shape [].
+        Shape is ``[]``.
 
     Methods
     -------
@@ -47,10 +47,11 @@ def __init__(
         ----------
         non_optimizable_parameters : torch.Tensor
             The four non-optimizable actuator parameters, describing actuator geometry.
-            Tensor of shape [number_of_heliostats, 4, 2].
+            Shape is ``[number_of_heliostats, 4, 2]``.
         optimizable_parameters : torch.Tensor
-            The ideal actuators do not have optimizable parameters, this tensor is therefore empty (default is torch.tensor([])).
-            Tensor of shape [].
+            The ideal actuators do not have optimizable parameters, this tensor is therefore empty
+            (default is ``torch.tensor([])``).
+            Shape is ``[]``.
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -72,7 +73,7 @@ def motor_positions_to_angles(
         ----------
         motor_positions : torch.Tensor
             The motor positions.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -95,7 +96,7 @@ def angles_to_motor_positions(
         ----------
         angles : torch.Tensor
             The joint angles.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
         device : torch.device | None
             The device on which to perform computations or load tensors and models (default is None).
             If None, ``ARTIST`` will automatically select the most appropriate
@@ -105,6 +106,6 @@ def angles_to_motor_positions(
         -------
         torch.Tensor
             The motor steps.
-            Tensor of shape [number_of_active_heliostats, 2].
+            Shape is ``[number_of_active_heliostats, 2]``.
         """
         return angles