Modular ground class, pre-commit, typos

.flake8

@@ -1,4 +1,4 @@
 [flake8]
 max-line-length=100
 extend-ignore=E203,D104,D100,I004
-exclude=*/tests/*,docs/source/tools/*
+exclude=*/tests/*,docs/source/tools/*

.github/workflows/commit-verification.yml

@@ -40,4 +40,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest
+        pytest

.gitignore

@@ -250,4 +250,4 @@ $RECYCLE.BIN/
 # Cosapp Systems representations
 **.html
 
-# End of https://www.gitignore.io/api/git,linux,macos,python,windows,pycharm,jupyternotebook
+# End of https://www.gitignore.io/api/git,linux,macos,python,windows,pycharm,jupyternotebook

.isort.cfg

@@ -4,4 +4,4 @@ known_third_party=pybind11,conda,conda_env
 multi_line_output=3
 include_trailing_comma=True
 force_grid_wrap=0
-use_parentheses=True
+use_parentheses=True

AUTHORS.md

@@ -1 +1 @@
-Luca Rodrigues Miguel
+Luca Rodrigues Miguel

LICENSE

@@ -3,4 +3,4 @@ Copyright (c) 2022, twiinIT - All Rights Reserved
 Unauthorized copying and/or distribution of this source-code, via any medium
 is strictly prohibited without the express permission of twiinIT.
 
-Proprietary and confidential.
+Proprietary and confidential.

MANIFEST.in

@@ -4,4 +4,4 @@ include README.md
 
 recursive-exclude tests *
 recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
+recursive-exclude * *.py[co]

README.md

@@ -6,20 +6,20 @@ This library was built with CoSApp, an open source framework allowing complex sy
 
 ## Getting Started
 
-After cloning the repository thanks to 
+After cloning the repository thanks to
 ```bash
 git clone https://github.com/twiinIT/rocket-twin.git
 ```
 
-install the dependencies via 
+install the dependencies via
 
 ```bash
 pip install -r requirements.txt
 ```
 
 ## How to use
 
-In order to use the graphic interface, move to the UI directory 
+In order to use the graphic interface, move to the UI directory
 and browse the jupyter notebook `user_interface.ipynb`.
 
 ## Overview

pyproject.toml

@@ -7,4 +7,4 @@ profile = "black"
 [tool.pytest.ini_options]
 pythonpath = [
   "."
-]
+]

requirements.txt

@@ -17,4 +17,4 @@ pytest
 flake8
 isort
 black
-pre-commit
+pre-commit

rocket_twin/drivers/__init__.py

@@ -1,5 +1,5 @@
-from rocket_twin.drivers.fuelling_rocket import FuellingRocket
+from rocket_twin.drivers.fueling_rocket import FuelingRocket
 from rocket_twin.drivers.mission import Mission
 from rocket_twin.drivers.vertical_flying_rocket import VerticalFlyingRocket
 
-__all__ = ["FuellingRocket", "VerticalFlyingRocket", "Mission"]
+__all__ = ["FuelingRocket", "VerticalFlyingRocket", "Mission"]

rocket_twin/drivers/fuelling_rocket.py → rocket_twin/drivers/fueling_rocket.py

@@ -5,7 +5,23 @@
 from cosapp.systems import System
 
 
-class FuellingRocket(Driver):
+class FuelingRocket(Driver):
+    """Driver that simulates the fueling of a rocket.
+    
+    Inputs
+    ------
+    name: string,
+        the name of the driver
+    w_out [kg/s]: float,
+        mass flow of fuel exiting the ground tank
+    dt [s]: float,
+        integration time step
+    owner: System,
+        the system that owns the driver
+
+    Outputs
+    ------
+    """
     def __init__(self, name: str, w_out, dt, owner: Optional["System"] = None, **kwargs):
         super().__init__(name, owner, **kwargs)
 
@@ -26,7 +42,9 @@ def __init__(self, name: str, w_out, dt, owner: Optional["System"] = None, **kwa
 
         self.rk.set_scenario(init=init, stop=stop)
         self.rk.add_recorder(
-            DataFrameRecorder(includes=["rocket.dyn.a", "g_tank.weight", "rocket.tank.weight_p"], hold=True),
+            DataFrameRecorder(
+                includes=["rocket.dyn.a", "g_tank.weight", "rocket.tank.weight_p"], hold=True
+            ),
             period=dt,
         )
         self.data = None

rocket_twin/drivers/mission.py

@@ -4,18 +4,35 @@
 from cosapp.drivers import Driver
 from cosapp.systems import System
 
-from rocket_twin.drivers.fuelling_rocket import FuellingRocket
+from rocket_twin.drivers.fueling_rocket import FuelingRocket
 from rocket_twin.drivers.vertical_flying_rocket import VerticalFlyingRocket
 
 
 class Mission(Driver):
-    def __init__(
-        self, name: str, w_in, w_out, dt, owner: Optional["System"] = None, **kwargs
-    ):
+    """Driver that simulates the fueling and the vertical flight of a rocket.
+
+    Inputs
+    ------
+    name: string,
+        the name of the driver
+    w_in [kg/s]: float,
+        mass flow of fuel entering the rocket tank during refueling
+    w_out [kg/s]: float,
+        mass flow of fuel exiting the rocket tank during flight
+    dt [s]: float,
+        integration time step
+    owner: System,
+        the system that owns the driver
+
+    Outputs
+    ------
+    """
+
+    def __init__(self, name: str, w_in, w_out, dt, owner: Optional["System"] = None, **kwargs):
         super().__init__(name, owner, **kwargs)
 
         # Fuelling
-        self.add_child(FuellingRocket("fuelling", w_out=w_in, dt=dt, owner=owner))
+        self.add_child(FuelingRocket("fuelling", w_out=w_in, dt=dt, owner=owner))
 
         # Flying
         self.add_child(VerticalFlyingRocket("flying", w_out=w_out, dt=dt, owner=owner))

rocket_twin/drivers/vertical_flying_rocket.py

@@ -6,6 +6,23 @@
 
 
 class VerticalFlyingRocket(Driver):
+    """Driver that simulates the vertical flight of a rocket.
+
+    Inputs
+    ------
+    name: string,
+        the name of the driver
+    w_out [kg/s]: float,
+        mass flow of fuel exiting the rocket tank
+    dt [s]: float,
+        integration time step
+    owner: System,
+        the system that owns the driver
+
+    Outputs
+    ------
+    """
+
     def __init__(self, name: str, w_out, dt, owner: Optional["System"] = None, **kwargs):
         super().__init__(name, owner, **kwargs)
 
@@ -26,7 +43,9 @@ def __init__(self, name: str, w_out, dt, owner: Optional["System"] = None, **kwa
 
         self.rk.set_scenario(init=init, stop=stop)
         self.rk.add_recorder(
-            DataFrameRecorder(includes=["rocket.dyn.a", "g_tank.weight", "rocket.tank.weight_p"], hold=True),
+            DataFrameRecorder(
+                includes=["rocket.dyn.a", "g_tank.weight", "rocket.tank.weight_p"], hold=True
+            ),
             period=dt,
         )
         self.data = None

rocket_twin/notebooks/test_sequences.ipynb

@@ -7,7 +7,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from rocket_twin.systems import Ground\n",
+    "from rocket_twin.systems import Station\n",
     "from rocket_twin.utils import run_sequences"
    ]
   },
@@ -20,7 +20,7 @@
    "source": [
     "#System creation\n",
     "\n",
-    "sys = Ground('sys')"
+    "sys = Station('sys')"
    ]
   },
   {
@@ -180,7 +180,7 @@
    "source": [
     "#Creates a second system to check behaviour when all sequences are executed together\n",
     "\n",
-    "sys2 = Ground('sys2')"
+    "sys2 = Station('sys2')"
    ]
   },
   {