Adding python module metadata

manumerous · manumerous · commit c09b7c25e42b · 2021-09-30T09:24:49.000-07:00
diff --git a/Tools/parametric_model/generate_parametric_model.py b/Tools/parametric_model/generate_parametric_model.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker, Jaeyoung Lim"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import os
 import src.models as models
 from src.tools import DataHandler
diff --git a/Tools/parametric_model/src/models/aerodynamic_models/control_surface_model.py b/Tools/parametric_model/src/models/aerodynamic_models/control_surface_model.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import math
 import numpy as np
 
diff --git a/Tools/parametric_model/src/models/aerodynamic_models/fuselage_drag_model.py b/Tools/parametric_model/src/models/aerodynamic_models/fuselage_drag_model.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import numpy as np
 
 
diff --git a/Tools/parametric_model/src/models/aerodynamic_models/standard_wing_model.py b/Tools/parametric_model/src/models/aerodynamic_models/standard_wing_model.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import math
 import numpy as np
 
diff --git a/Tools/parametric_model/src/models/dynamics_model.py b/Tools/parametric_model/src/models/dynamics_model.py
@@ -32,27 +32,30 @@
  *
 """
 
-""" The model class contains properties shared between all models and shgall simplyfy automated checks and the later
-export to a sitl gazebo model by providing a unified interface for all models. """
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
 
+from src.tools.math_tools import cropped_sym_sigmoid
+from src.tools.quat_utils import quaternion_to_rotation_matrix
+from src.tools.dataframe_tools import compute_flight_time, resample_dataframe_list
+from src.tools.ulog_tools import load_ulog, pandas_from_topic
+from .model_plots import model_plots, aerodynamics_plots, linear_model_plots
+from .rotor_models import RotorModel, BiDirectionalRotorModel, TiltingRotorModel, ChangingAxisRotorModel
+import matplotlib.pyplot as plt
+from scipy.linalg import block_diag
+import src.optimizers as optimizers
+import numpy as np
+import yaml
+import time
+import math
+import pandas as pd
+from progress.bar import Bar
 
+""" The model class contains properties shared between all models and shgall simplyfy automated checks and the later
+export to a sitl gazebo model by providing a unified interface for all models. """
 
 
-from progress.bar import Bar
-import pandas as pd
-import math
-import time
-import yaml
-import numpy as np
-import src.optimizers as optimizers
-from scipy.linalg import block_diag
-import matplotlib.pyplot as plt
-from .rotor_models import RotorModel, BiDirectionalRotorModel, TiltingRotorModel, ChangingAxisRotorModel
-from .model_plots import model_plots, aerodynamics_plots, linear_model_plots
-from src.tools.ulog_tools import load_ulog, pandas_from_topic
-from src.tools.dataframe_tools import compute_flight_time, resample_dataframe_list
-from src.tools.quat_utils import quaternion_to_rotation_matrix
-from src.tools.math_tools import cropped_sym_sigmoid
 class DynamicsModel():
     def __init__(self, config_dict):
 
diff --git a/Tools/parametric_model/src/models/model_config.py b/Tools/parametric_model/src/models/model_config.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import os
 import yaml
 from pathlib import Path
diff --git a/Tools/parametric_model/src/models/model_plots/aerodynamics_plots.py b/Tools/parametric_model/src/models/model_plots/aerodynamics_plots.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import matplotlib.pyplot as plt
 import numpy as np
 import math
diff --git a/Tools/parametric_model/src/models/model_plots/linear_model_plots.py b/Tools/parametric_model/src/models/model_plots/linear_model_plots.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import seaborn as sns
 import matplotlib
 import pandas as pd
diff --git a/Tools/parametric_model/src/models/model_plots/model_plots.py b/Tools/parametric_model/src/models/model_plots/model_plots.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import matplotlib.pyplot as plt
 import numpy as np
 import math
diff --git a/Tools/parametric_model/src/models/model_plots/rotor_plots.py b/Tools/parametric_model/src/models/model_plots/rotor_plots.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import matplotlib.pyplot as plt
 import numpy as np
 import math
diff --git a/Tools/parametric_model/src/models/multirotor_model.py b/Tools/parametric_model/src/models/multirotor_model.py
@@ -30,9 +30,8 @@
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
-"""
 
-""" The model in this file estimates a simple force motor model for a multirotor.
+The model in this file estimates a simple force motor model for a multirotor.
 
 Model Parameters:
 u                    : normalized actuator output scaled between 0 and 1
@@ -51,18 +50,21 @@
 Note that the forces are calculated in the NED body frame and are therefore negative.
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
 
-
-
-import numpy as np
-import pandas as pd
-import matplotlib.pyplot as plt
-import math
 from sklearn.linear_model import LinearRegression
 from .dynamics_model import DynamicsModel
 from .rotor_models import RotorModel
 from .aerodynamic_models import FuselageDragModel
 from .model_config import ModelConfig
+import numpy as np
+import pandas as pd
+import matplotlib.pyplot as plt
+import math
+
+
 class MultiRotorModel(DynamicsModel):
     def __init__(self, config_file, model_name="multirotor_model"):
         self.config = ModelConfig(config_file)
diff --git a/Tools/parametric_model/src/models/rotor_models/bi_directional_rotor_model.py b/Tools/parametric_model/src/models/rotor_models/bi_directional_rotor_model.py
@@ -1,5 +1,39 @@
-__author__ = "Manuel Galliker"
-__maintainer__ = "Manuel Galliker"
+"""
+ *
+ * Copyright (c) 2021 Manuel Yves Galliker
+ *               2021 Autonomous Systems Lab ETH Zurich
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name Data Driven Dynamics nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+"""
+
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
 __license__ = "BSD 3"
 
 import numpy as np
diff --git a/Tools/parametric_model/src/models/rotor_models/changing_axis_rotor_model.py b/Tools/parametric_model/src/models/rotor_models/changing_axis_rotor_model.py
@@ -1,5 +1,39 @@
-__author__ = "Manuel Galliker"
-__maintainer__ = "Manuel Galliker"
+"""
+ *
+ * Copyright (c) 2021 Manuel Yves Galliker
+ *               2021 Autonomous Systems Lab ETH Zurich
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name Data Driven Dynamics nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+"""
+
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
 __license__ = "BSD 3"
 
 from . import RotorModel
diff --git a/Tools/parametric_model/src/models/rotor_models/rotor_model.py b/Tools/parametric_model/src/models/rotor_models/rotor_model.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import numpy as np
 import pandas as pd
 import math
diff --git a/Tools/parametric_model/src/models/rotor_models/tilting_rotor_model.py b/Tools/parametric_model/src/models/rotor_models/tilting_rotor_model.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 from . import ChangingAxisRotorModel
 import numpy as np
 import pandas as pd
diff --git a/Tools/parametric_model/src/optimizers/linear_regressor.py b/Tools/parametric_model/src/optimizers/linear_regressor.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 from src.optimizers import OptimizerBaseTemplate
 from sklearn.linear_model import LinearRegression
 from src.tools import math_tools
diff --git a/Tools/parametric_model/src/optimizers/optimizer_base_template.py b/Tools/parametric_model/src/optimizers/optimizer_base_template.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 from abc import ABC, abstractmethod
 from typing import Dict, List
 
diff --git a/Tools/parametric_model/src/optimizers/qp_optimizer.py b/Tools/parametric_model/src/optimizers/qp_optimizer.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 from src.optimizers import OptimizerBaseTemplate
 import cvxpy
 import numpy as np
diff --git a/Tools/parametric_model/src/tools/data_handler.py b/Tools/parametric_model/src/tools/data_handler.py
@@ -30,13 +30,13 @@
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
-"""
 
-""" The model class contains properties shared between all models and shgall simplyfy automated checks and the later
+The model class contains properties shared between all models and shgall simplyfy automated checks and the later
 export to a sitl gazebo model by providing a unified interface for all models. """
 
-
-
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
 
 from progress.bar import Bar
 import pandas as pd
@@ -50,6 +50,8 @@
 from src.tools.ulog_tools import load_ulog, pandas_from_topic
 from src.tools.dataframe_tools import compute_flight_time, resample_dataframe_list
 from src.tools.quat_utils import quaternion_to_rotation_matrix
+
+
 class DataHandler(object):
 
     visual_dataframe_selector_config_dict = {
diff --git a/Tools/parametric_model/src/tools/dataframe_tools.py b/Tools/parametric_model/src/tools/dataframe_tools.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import numpy as np
 import pandas as pd
 from src.tools.ulog_tools import pandas_from_topic
diff --git a/Tools/parametric_model/src/tools/math_tools.py b/Tools/parametric_model/src/tools/math_tools.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import math
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/Tools/parametric_model/src/tools/quat_utils.py b/Tools/parametric_model/src/tools/quat_utils.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker, Nicholas Lawrance"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import numpy as np
 import csv
 import h5py
diff --git a/Tools/parametric_model/src/tools/ulog_tools.py b/Tools/parametric_model/src/tools/ulog_tools.py
@@ -32,6 +32,10 @@
  *
 """
 
+__author__ = "Manuel Yves Galliker"
+__maintainer__ = "Manuel Yves Galliker"
+__license__ = "BSD 3"
+
 import pandas as pd
 import os
 
diff --git a/Tools/parametric_model/tests/test_dynamics_model.py b/Tools/parametric_model/tests/test_dynamics_model.py
diff --git a/Tools/parametric_model/tests/test_rotor_model.py b/Tools/parametric_model/tests/test_rotor_model.py
diff --git a/Tools/parametric_model/tests/test_tilting_rotor.py b/Tools/parametric_model/tests/test_tilting_rotor.py

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,10 @@`
`32`	`32`	`*`
`33`	`33`	`"""`
`34`	`34`
	`35`	`+__author__ = "Manuel Yves Galliker"`
	`36`	`+__maintainer__ = "Manuel Yves Galliker"`
	`37`	`+__license__ = "BSD 3"`
	`38`	`+`
`35`	`39`	`import math`
`36`	`40`	`import numpy as np`
`37`	`41`