rtc-tools 2.5.2rc3__py3-none-any.whl → 2.6.0__py3-none-any.whl

rtctools/util.py

@@ -26,9 +26,9 @@ def _resolve_folder(kwargs, base_folder, subfolder_kw, default):
         return os.path.join(base_folder, subfolder)
 
 
-def run_optimization_problem(optimization_problem_class,
-                             base_folder='..', log_level=logging.INFO, profile=False,
-                             **kwargs):
+def run_optimization_problem(
+    optimization_problem_class, base_folder="..", log_level=logging.INFO, profile=False, **kwargs
+):
     """
     Sets up and solves an optimization problem.
 
@@ -36,9 +36,12 @@ def run_optimization_problem(optimization_problem_class,
 
     1. That the ``base_folder`` contains subfolders ``input``, ``output``, and ``model``,
        containing input data, output data, and the model, respectively.
-    2. When using :class:`.CSVLookupTableMixin`, that the base folder contains a subfolder ``lookup_tables``.
-    3. When using :class:`.ModelicaMixin`, that the base folder contains a subfolder ``model``.
-    4. When using :class:`.ModelicaMixin`, that the toplevel Modelica model name equals the class name.
+    2. When using :class:`.CSVLookupTableMixin`, that the base folder contains
+       a subfolder ``lookup_tables``.
+    3. When using :class:`.ModelicaMixin`, that the base folder contains
+       a subfolder ``model``.
+    4. When using :class:`.ModelicaMixin`, that the toplevel Modelica model name
+       equals the class name.
 
     :param optimization_problem_class: Optimization problem class to solve.
     :param base_folder:                Base folder.
@@ -51,36 +54,42 @@ def run_optimization_problem(optimization_problem_class,
     # Do some checks on the problem class
     if issubclass(optimization_problem_class, SimulationCSVMixin):
         raise ValueError(
-            "Optimization problem class cannot be derived from simulation.csv_mixin.CSVMixin.")
+            "Optimization problem class cannot be derived from simulation.csv_mixin.CSVMixin."
+        )
     if issubclass(optimization_problem_class, SimulationIOMixin):
         raise ValueError(
-            "Optimization problem class cannot be derived from simulation.csv_mixin.IOMixin.")
+            "Optimization problem class cannot be derived from simulation.csv_mixin.IOMixin."
+        )
     if issubclass(optimization_problem_class, SimulationPIMixin):
         raise ValueError(
-            "Optimization problem class cannot be derived from simulation.csv_mixin.PIMixin.")
+            "Optimization problem class cannot be derived from simulation.csv_mixin.PIMixin."
+        )
 
     # Set input/output folders
     if not os.path.isabs(base_folder):
         # Resolve base folder relative to script folder
         base_folder = os.path.join(sys.path[0], base_folder)
 
-    model_folder = _resolve_folder(kwargs, base_folder, 'model_folder', 'model')
-    input_folder = _resolve_folder(kwargs, base_folder, 'input_folder', 'input')
-    output_folder = _resolve_folder(kwargs, base_folder, 'output_folder', 'output')
+    model_folder = _resolve_folder(kwargs, base_folder, "model_folder", "model")
+    input_folder = _resolve_folder(kwargs, base_folder, "input_folder", "input")
+    output_folder = _resolve_folder(kwargs, base_folder, "output_folder", "output")
 
     # Set up logging
     logger = logging.getLogger("rtctools")
 
     # Add stream handler if it does not already exist.
-    if not logger.hasHandlers() and not any((isinstance(h, logging.StreamHandler) for h in logger.handlers)):
+    if not logger.hasHandlers() and not any(
+        (isinstance(h, logging.StreamHandler) for h in logger.handlers)
+    ):
         handler = logging.StreamHandler()
-        formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
+        formatter = logging.Formatter("%(asctime)s %(levelname)s %(message)s")
         handler.setFormatter(formatter)
         logger.addHandler(handler)
 
     # Add pi.DiagHandler, if using PIMixin. Only add it if it does not already exist.
-    if (issubclass(optimization_problem_class, OptimizationPIMixin) and
-            not any((isinstance(h, pi.DiagHandler) for h in logger.handlers))):
+    if issubclass(optimization_problem_class, OptimizationPIMixin) and not any(
+        (isinstance(h, pi.DiagHandler) for h in logger.handlers)
+    ):
         handler = pi.DiagHandler(output_folder)
         logger.addHandler(handler)
 
@@ -88,29 +97,42 @@ def run_optimization_problem(optimization_problem_class,
     logger.setLevel(log_level)
 
     # Log version info
-    logger.info(
-        "Using RTC-Tools {}.".format(__version__))
-    logger.debug(
-        "Using CasADi {}.".format(casadi.__version__))
+    logger.info("Using RTC-Tools {}.".format(__version__))
+    logger.debug("Using CasADi {}.".format(casadi.__version__))
 
     # Check for some common mistakes in inheritance order
-    suggested_order = OrderedSet([
-        'HomotopyMixin',
-        'MinAbsGoalProgrammingMixin', 'LinearizedOrderGoalProgrammingMixin',
-        'SinglePassGoalProgrammingMixin', 'GoalProgrammingMixin',
-        'PIMixin', 'CSVMixin', 'ModelicaMixin',
-        'ControlTreeMixin', 'CollocatedIntegratedOptimizationProblem', 'OptimizationProblem'])
+    suggested_order = OrderedSet(
+        [
+            "HomotopyMixin",
+            "MinAbsGoalProgrammingMixin",
+            "LinearizedOrderGoalProgrammingMixin",
+            "SinglePassGoalProgrammingMixin",
+            "GoalProgrammingMixin",
+            "PIMixin",
+            "CSVMixin",
+            "ModelicaMixin",
+            "PlanningMixin",
+            "ControlTreeMixin",
+            "CollocatedIntegratedOptimizationProblem",
+            "OptimizationProblem",
+        ]
+    )
     base_names = OrderedSet([b.__name__ for b in optimization_problem_class.__bases__])
     if suggested_order & base_names != base_names & suggested_order:
-        msg = 'Please inherit from base classes in the following order: {}'.format(list(base_names & suggested_order))
+        msg = "Please inherit from base classes in the following order: {}".format(
+            list(base_names & suggested_order)
+        )
         logger.error(msg)
         raise Exception(msg)
 
     # Run
     try:
         prob = optimization_problem_class(
-            model_folder=model_folder, input_folder=input_folder, output_folder=output_folder,
-            **kwargs)
+            model_folder=model_folder,
+            input_folder=input_folder,
+            output_folder=output_folder,
+            **kwargs,
+        )
         if profile:
             filename = os.path.join(base_folder, "profile.prof")
 
@@ -128,13 +150,15 @@ def run_optimization_problem(optimization_problem_class,
             value = exc_info[1]
             try:
                 failed_class = re.search(
-                    "Can't instantiate (.*) with abstract methods", str(value)).group(1)
-                abstract_method = re.search(
-                    ' with abstract methods (.*)', str(value)).group(1)
+                    "Can't instantiate (.*) with abstract methods", str(value)
+                ).group(1)
+                abstract_method = re.search(" with abstract methods (.*)", str(value)).group(1)
                 logger.error(
-                    'The {} is missing a mixin. Please add a mixin that instantiates '
-                    'abstract method {}, so that the optimizer can run.'.format(
-                        failed_class, abstract_method))
+                    "The {} is missing a mixin. Please add a mixin that instantiates "
+                    "abstract method {}, so that the optimizer can run.".format(
+                        failed_class, abstract_method
+                    )
+                )
             except Exception:
                 pass
         for handler in logger.handlers:
@@ -142,15 +166,15 @@ def run_optimization_problem(optimization_problem_class,
         raise
 
 
-def run_simulation_problem(simulation_problem_class,
-                           base_folder='..', log_level=logging.INFO,
-                           **kwargs):
+def run_simulation_problem(
+    simulation_problem_class, base_folder="..", log_level=logging.INFO, **kwargs
+):
     """
     Sets up and runs a simulation problem.
 
     :param simulation_problem_class: Simulation problem class to solve.
-    :param base_folder:              Folder within which subfolders "input", "output", and "model" exist,
-                                     containing input and output data, and the model, respectively.
+    :param base_folder:              Folder within which subfolders "input", "output", and "model"
+        exist, containing input and output data, and the model, respectively.
     :param log_level:                The log level to use.
 
     :returns: :class:`SimulationProblem` instance.
@@ -159,13 +183,16 @@ def run_simulation_problem(simulation_problem_class,
     # Do some checks on the problem class
     if issubclass(simulation_problem_class, OptimizationCSVMixin):
         raise ValueError(
-            "Simulation problem class cannot be derived from optimization.csv_mixin.CSVMixin.")
+            "Simulation problem class cannot be derived from optimization.csv_mixin.CSVMixin."
+        )
     if issubclass(simulation_problem_class, OptimizationIOMixin):
         raise ValueError(
-            "Simulation problem class cannot be derived from optimization.csv_mixin.IOMixin.")
+            "Simulation problem class cannot be derived from optimization.csv_mixin.IOMixin."
+        )
     if issubclass(simulation_problem_class, OptimizationPIMixin):
         raise ValueError(
-            "Simulation problem class cannot be derived from optimization.csv_mixin.PIMixin.")
+            "Simulation problem class cannot be derived from optimization.csv_mixin.PIMixin."
+        )
 
     # Set input/output folders
     if base_folder is None:
@@ -179,34 +206,35 @@ def run_simulation_problem(simulation_problem_class,
             # Resolve base folder relative to script folder
             base_folder = os.path.join(sys.path[0], base_folder)
 
-    model_folder = _resolve_folder(kwargs, base_folder, 'model_folder', 'model')
-    input_folder = _resolve_folder(kwargs, base_folder, 'input_folder', 'input')
-    output_folder = _resolve_folder(kwargs, base_folder, 'output_folder', 'output')
+    model_folder = _resolve_folder(kwargs, base_folder, "model_folder", "model")
+    input_folder = _resolve_folder(kwargs, base_folder, "input_folder", "input")
+    output_folder = _resolve_folder(kwargs, base_folder, "output_folder", "output")
 
     # Set up logging
     logger = logging.getLogger("rtctools")
-    if not logger.hasHandlers() and not any((isinstance(h, logging.StreamHandler) for h in logger.handlers)):
+    if not logger.hasHandlers() and not any(
+        (isinstance(h, logging.StreamHandler) for h in logger.handlers)
+    ):
         handler = logging.StreamHandler()
-        formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
+        formatter = logging.Formatter("%(asctime)s %(levelname)s %(message)s")
         handler.setFormatter(formatter)
         logger.addHandler(handler)
 
     # Add pi.DiagHandler, if using PIMixin. Only add it if it does not already exist.
-    if (issubclass(simulation_problem_class, SimulationPIMixin) and
-            not any((isinstance(h, pi.DiagHandler) for h in logger.handlers))):
+    if issubclass(simulation_problem_class, SimulationPIMixin) and not any(
+        (isinstance(h, pi.DiagHandler) for h in logger.handlers)
+    ):
         handler = pi.DiagHandler(output_folder)
         logger.addHandler(handler)
 
     logger.setLevel(log_level)
 
-    logger.info(
-        'Using RTC-Tools {}'.format(__version__))
-    logger.debug(
-        'Using CasADi {}.'.format(casadi.__version__))
+    logger.info("Using RTC-Tools {}".format(__version__))
+    logger.debug("Using CasADi {}.".format(casadi.__version__))
 
     # Run
     prob = simulation_problem_class(
-        model_folder=model_folder, input_folder=input_folder, output_folder=output_folder,
-        **kwargs)
+        model_folder=model_folder, input_folder=input_folder, output_folder=output_folder, **kwargs
+    )
     prob.simulate()
     return prob

rtc_tools-2.5.2rc3.dist-info/RECORD

@@ -1,49 +0,0 @@
-rtctools/__init__.py,sha256=GzuYmrfvai2LnOnLGZUweYWn4SJQH9txwzwVO-ykvN4,106
-rtctools/_version.py,sha256=MbT8a-OnwVZRth24l2b35B12YzffQOVyu3w3qOPMFp0,500
-rtctools/rtctoolsapp.py,sha256=tK8hLfozegtH9kY5bmAox8lCE427uhxBWEp5pBqhiSA,4193
-rtctools/util.py,sha256=v2NLIB7NAqb_FvwNY2md7lgSXkfz_3M7xOuZcImM0Kw,8905
-rtctools/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rtctools/_internal/alias_tools.py,sha256=4lVd2S1gK3AlR5Wns79EVmTq4I2SSXIzUgeqL2VMIoo,5336
-rtctools/_internal/caching.py,sha256=CIJQ0oi-S2TQ7EM1oYzYN3CMfZe1F8R5-kIis1tNcIc,903
-rtctools/_internal/casadi_helpers.py,sha256=-hEgtp88koJSyok-_081i2QAzKKLGGVHcv5-4D2vRB8,2243
-rtctools/_internal/debug_check_helpers.py,sha256=YDPNB2yVY2Lkztoz8GabG0TX3-2CS0DNCIwMWQRT68Y,1084
-rtctools/data/__init__.py,sha256=k4WorSsD-Y8l2meIYHPaSOdGEgonribLkyoMASAhe90,157
-rtctools/data/csv.py,sha256=1pEYJ2Y0pxNFONH0iwacAbkKb3959lyqA_-jQ0O4CPo,4947
-rtctools/data/netcdf.py,sha256=QpAzAowSdmbJRkuPLCFbhoyGpecxZENhJi9Tjc7YDOY,18692
-rtctools/data/pi.py,sha256=RR66S-lQRPStDyMjF7ccam-LVvWpA92zGfKeEM2cpoo,43530
-rtctools/data/rtc.py,sha256=2cPDTuU0T4GiueG8ESHUPObtkDY9jahEBQ48Bc-CCeg,8853
-rtctools/data/storage.py,sha256=A2U1OuBzzTYADCN_BhLf9mmIQN4BZ_GNG_DdN_JoGoo,13011
-rtctools/data/interpolation/__init__.py,sha256=GBubCIT5mFoSTV-lOk7cpwvZekNMEe5bvqSQJ9HE34M,73
-rtctools/data/interpolation/bspline.py,sha256=xg1PqXlbpBZ5dPE5ngvdnJ7utSZyx8BgMqdDDLL8Hgw,958
-rtctools/data/interpolation/bspline1d.py,sha256=tNAQmTerjC0XWP5YQZZUp67jzVbOVmmyV6xzr81KL1g,5985
-rtctools/data/interpolation/bspline2d.py,sha256=RJO9XbjrNFNgkYjS88l-c4miu9xW1yroACpQ9v0u7bg,1607
-rtctools/optimization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rtctools/optimization/collocated_integrated_optimization_problem.py,sha256=TnxYTUJ9nGVxGs7Hrkk8y10PQEAU9kgA4qG66imIYdE,117456
-rtctools/optimization/control_tree_mixin.py,sha256=dZBEvhLToqiuwei5Nvv6ywXtaa08zgueKI5p4m-JyzQ,9026
-rtctools/optimization/csv_lookup_table_mixin.py,sha256=mEZdl1ca69K9ptJdKxCGIle4MrAwBTB4AJiVYQctyZg,16651
-rtctools/optimization/csv_mixin.py,sha256=FvMcuLlKu-YJo2NNudwMUUYKNb6HN4cevndWjlo5nis,11624
-rtctools/optimization/goal_programming_mixin.py,sha256=uzi2Kpr_i1ORfjB5Sta-mrMZXa3Xz0RCmG3AWsBn-L0,31608
-rtctools/optimization/goal_programming_mixin_base.py,sha256=NSyDuZD46fLadpM3tE-CXELStMBlH9IdlIaTkl_osOU,41999
-rtctools/optimization/homotopy_mixin.py,sha256=cgRPL-Ag9kd4iJQMbgKrRok-BUaRQwVJSCiAw_-1eck,6782
-rtctools/optimization/initial_state_estimation_mixin.py,sha256=CasRmqWVtyEpc4DwWcvpEcHBX7y0jsFERg5MSVb2FUo,3126
-rtctools/optimization/io_mixin.py,sha256=ZvltLXl1UON_GzlPVfkuvZvM2DUsz71B4HPVDoOSMgg,11817
-rtctools/optimization/linearization_mixin.py,sha256=ZG7553zowwSgl9Roe2yc24cp0DlqKkb2cmImGnaVGt0,1019
-rtctools/optimization/linearized_order_goal_programming_mixin.py,sha256=Aws3b0rnL-t8Bp_KOI9TbqqcuLb5ofSKKQMYjtUtLS0,8736
-rtctools/optimization/min_abs_goal_programming_mixin.py,sha256=kom9pV7Th5N31Adoc9RZRlQTcfqIzwui0PDe5AQnYuU,13293
-rtctools/optimization/modelica_mixin.py,sha256=usc9GZLLX8rjDIbIR9pI7m9wU7cwC8eXRszrvr8UN3I,16198
-rtctools/optimization/netcdf_mixin.py,sha256=fqhQSiSARQ4l6lwqp6ZDQ-SuIAeMPkQ69NcFnvk97C4,7259
-rtctools/optimization/optimization_problem.py,sha256=iUXcSz-jo4U9fhC3hWBLtkRosyrKg2LaTbYp46onL8w,43624
-rtctools/optimization/pi_mixin.py,sha256=QeHodXb5EO2Ueou8RUjeUfJMuv-cd55vCMi1dHuN4Q4,10783
-rtctools/optimization/single_pass_goal_programming_mixin.py,sha256=LxLquZYAnhR5wV39S3cgL3jKKQi4C3n6i0K55DETSdc,25126
-rtctools/optimization/timeseries.py,sha256=W2xYBZRZxKgOQ0aW_le5NDbXOBbokCeK-mjSUUa_EVs,1753
-rtctools/simulation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rtctools/simulation/csv_mixin.py,sha256=SIggsf7lfml3iWyhFSzCSCdxLt86ElluJQYxPYUkSiQ,6606
-rtctools/simulation/io_mixin.py,sha256=DizXxYg3MhOqyYXdHVlF9rLTfOo_aXc59Jh_hzGcgkc,6163
-rtctools/simulation/pi_mixin.py,sha256=ejHStj5LVILAnaqkoRGmXjxJ-XiUlV8L8-_VkmPEeGE,8922
-rtctools/simulation/simulation_problem.py,sha256=BiiijrKqD-G5QnFecs0vGHICD9QTxmfRZPEdwSrZtMM,35419
-rtc_tools-2.5.2rc3.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-rtc_tools-2.5.2rc3.dist-info/METADATA,sha256=EwEm47q4dRyM0yP77oEedzVBaMhPmbFazq8HKMsJWvk,1455
-rtc_tools-2.5.2rc3.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-rtc_tools-2.5.2rc3.dist-info/entry_points.txt,sha256=-x622IB_l1duw2M6t6syfQ4yzOiQTp0IZxKGcYRgWgk,151
-rtc_tools-2.5.2rc3.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
-rtc_tools-2.5.2rc3.dist-info/RECORD,,