Source code for fastoad.cmd.api

"""
API
"""
#  This file is part of FAST-OAD : A framework for rapid Overall Aircraft Design
#  Copyright (C) 2022 ONERA & ISAE-SUPAERO
#  FAST is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <https://www.gnu.org/licenses/>.

import logging
import os
import os.path as pth
import shutil
import sys
import textwrap as tw
from collections import defaultdict
from collections.abc import Iterable
from time import time
from typing import Dict, IO, List, Union

import openmdao.api as om
import pandas as pd
from IPython import InteractiveShell
from IPython.display import HTML, clear_output, display
from tabulate import tabulate

import fastoad.openmdao.whatsopt
from fastoad._utils.files import make_parent_dir
from fastoad._utils.resource_management.copy import copy_resource, copy_resource_folder
from fastoad.cmd.exceptions import (
    FastNoAvailableNotebookError,
    FastPathExistsError,
)
from fastoad.gui import OptimizationViewer, VariableViewer
from fastoad.io import IVariableIOFormatter
from fastoad.io.configuration import FASTOADProblemConfigurator
from fastoad.io.variable_io import DataFile
from fastoad.io.xml import VariableLegacy1XmlFormatter
from fastoad.module_management._bundle_loader import BundleLoader
from fastoad.module_management._plugins import DistributionPluginDefinition, FastoadLoader
from fastoad.module_management.service_registry import RegisterOpenMDAOSystem, RegisterPropulsion
from fastoad.openmdao.problem import FASTOADProblem
from fastoad.openmdao.variables import VariableList

DEFAULT_WOP_URL = "https://ether.onera.fr/whatsopt"
_LOGGER = logging.getLogger(__name__)

# Used for test purposes only
_PROBLEM_CONFIGURATOR = None


[docs]def get_plugin_information(print_data=False) -> Dict[str, DistributionPluginDefinition]: """ Provides information about available FAST-OAD plugins. :param print_data: if True, plugin data are displayed. :return: a dict with installed package names as keys and matching FAST-OAD plugin definitions as values. """ plugin_definitions = FastoadLoader().distribution_plugin_definitions if print_data: table_dicts = [plugin_def.to_dict() for plugin_def in plugin_definitions.values()] if table_dicts: table = pd.DataFrame(table_dicts) if InteractiveShell.initialized(): display(HTML(table.to_html(index=False))) else: print(table.to_markdown(index=False)) else: print("No available FAST-OAD plugin.") return plugin_definitions
[docs]def generate_notebooks( destination_path: str, overwrite: bool = False, distribution_name=None, ): """ Copies notebook folder(s) from available plugin(s). :param destination_path: the inner structure of the folders will depend on the number of installed package and the number of plugins they contain. :param overwrite: if True and `destination_path` exists, it will be removed before writing. :param distribution_name: the name of an installed package that provides notebooks """ # Check available notebooks folder_info_list = FastoadLoader().get_notebook_folder_list(distribution_name) if len(folder_info_list) == 0: raise FastNoAvailableNotebookError(distribution_name) # Create and copy folder destination_path = pth.abspath(destination_path) if pth.exists(destination_path): if overwrite: shutil.rmtree(destination_path) else: raise FastPathExistsError( f"Notebook folder {destination_path} not written because it already exists. " "Use overwrite=True to bypass.", destination_path, ) # Write notebooks # We organize folder_info_list as dict of dict to easily count how many distributions # and plugin by distributions we have, which info is used for building target paths. folder_info_dict = defaultdict(dict) for folder_info in folder_info_list: folder_info_dict[folder_info.dist_name][folder_info.plugin_name] = folder_info only_one_dist = len(folder_info_dict) == 1 for dist_content in folder_info_dict.values(): only_one_plugin = len(dist_content) == 1 for folder_info in dist_content.values(): target_path_elements = [destination_path] if not only_one_dist: target_path_elements.append(folder_info.dist_name) if not only_one_plugin: target_path_elements.append(folder_info.plugin_name) target_path = pth.join(*target_path_elements) os.makedirs(target_path) copy_resource_folder(folder_info.package_name, target_path) return destination_path
[docs]def generate_configuration_file( configuration_file_path: str, overwrite: bool = False, distribution_name=None, sample_file_name=None, ): """ Copies a sample configuration file from an available plugin. :param configuration_file_path: the path of file to be written :param overwrite: if True, the file will be written, even if it already exists :param distribution_name: the name of the installed package that provides the sample configuration file (can be omitted if only one plugin is available) :param sample_file_name: the name of the sample configuration file (can be omitted if the plugin provides only one configuration file) :return: path of generated file :raise FastPathExistsError: if overwrite==False and configuration_file_path already exists """ if distribution_name is None: # If no distribution is specified, but only one contains configuration files, no need to # specify the name count_plugin_with_conf_file = 0 dist_with_conf_file = "" plugin_config_files = { name: [resource.name for resource in definition.get_configuration_file_list()] for name, definition in get_plugin_information().items() } for plugin_name, conf_files in plugin_config_files.items(): # Plugin is retained if it contains conf files. Additionally, if sample_file_name # is provided, plugin is retained only if sample_file_name is in provided conf files. if len(conf_files) > 0 and (sample_file_name is None or sample_file_name in conf_files): count_plugin_with_conf_file += 1 dist_with_conf_file = plugin_name if count_plugin_with_conf_file > 1: break # If only one plugin has been retained, it can be used as automatically selected plugin. if count_plugin_with_conf_file == 1: distribution_name = dist_with_conf_file dist_definition = FastoadLoader().get_distribution_plugin_definition(distribution_name) file_info = dist_definition.get_configuration_file_info(sample_file_name) # Check on file overwrite configuration_file_path = pth.abspath(configuration_file_path) if not overwrite and pth.exists(configuration_file_path): raise FastPathExistsError( f"Configuration file {configuration_file_path} not written because it already exists. " "Use overwrite=True to bypass.", configuration_file_path, ) # Write file make_parent_dir(configuration_file_path) copy_resource(file_info.package_name, file_info.name, configuration_file_path) _LOGGER.info('Sample configuration written in "%s".', configuration_file_path) return configuration_file_path
[docs]def generate_inputs( configuration_file_path: str, source_path: str = None, source_path_schema="native", overwrite: bool = False, ) -> str: """ Generates input file for the problem specified in configuration_file_path. :param configuration_file_path: where the path of input file to write is set :param source_path: path of file data will be taken from :param source_path_schema: set to 'legacy' if the source file come from legacy FAST :param overwrite: if True, file will be written even if one already exists :return: path of generated file :raise FastPathExistsError: if overwrite==False and configuration_file_path already exists """ conf = FASTOADProblemConfigurator(configuration_file_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) input_file_path = conf.input_file_path if not overwrite and pth.exists(conf.input_file_path): raise FastPathExistsError( f"Input file {input_file_path} not written because it already exists. " "Use overwrite=True to bypass.", input_file_path, ) if source_path_schema == "legacy": conf.write_needed_inputs(source_path, VariableLegacy1XmlFormatter()) else: conf.write_needed_inputs(source_path) _LOGGER.info("Problem inputs written in %s", input_file_path) return input_file_path
[docs]def list_variables( configuration_file_path: str, out: Union[IO, str] = None, overwrite: bool = False, force_text_output: bool = False, tablefmt: str = "grid", ): """ Writes list of variables for the problem specified in configuration_file_path. List is generally written as text. It can be displayed as a scrollable table view if: - function is used in an interactive IPython shell - out == sys.stdout - force_text_output == False :param configuration_file_path: :param out: the output stream or a path for the output file (None means sys.stdout) :param overwrite: if True and out parameter is a file path, the file will be written even if one already exists :param force_text_output: if True, list will be written as text, even if command is used in an interactive IPython shell (Jupyter notebook). Has no effect in other shells or if out parameter is not sys.stdout :param tablefmt: The formatting of the requested table. Options are the same as those available to the tabulate package. See tabulate.tabulate_formats for a complete list. If "var_desc" the file will use the variable_descriptions.txt format. :return: path of generated file, or None if no file was generated. :raise FastPathExistsError: if `overwrite==False` and `out` is a file path and the file exists """ if out is None: out = sys.stdout conf = FASTOADProblemConfigurator(configuration_file_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) problem = conf.get_problem() problem.setup() # Extracting inputs and outputs variables = VariableList.from_problem(problem) variables.sort(key=lambda var: var.name) input_variables = VariableList([var for var in variables if var.is_input]) output_variables = VariableList([var for var in variables if not var.is_input]) for var in input_variables: var.metadata["I/O"] = "IN" for var in output_variables: var.metadata["I/O"] = "OUT" variables_df = ( (input_variables + output_variables) .to_dataframe()[["name", "I/O", "desc"]] .rename(columns={"name": "NAME", "desc": "DESCRIPTION"}) ) if isinstance(out, str): out = pth.abspath(out) if not overwrite and pth.exists(out): raise FastPathExistsError( f"File {out} not written because it already exists. " "Use overwrite=True to bypass.", out, ) make_parent_dir(out) out_file = open(out, "w", encoding="utf-8") else: if out == sys.stdout and InteractiveShell.initialized() and not force_text_output: display(HTML(variables_df.to_html(index=False))) return None # Here we continue with text output out_file = out if tablefmt == "var_desc": content = _generate_var_desc_format(variables_df) else: content = _generate_table_format(variables_df, tablefmt=tablefmt) out_file.write(content) if isinstance(out, str): out_file.close() _LOGGER.info("Output list written in %s", out) return out return None
def _generate_var_desc_format(variables_df): content = variables_df.to_csv( columns=["NAME", "DESCRIPTION"], sep="|", index=False, header=False, line_terminator="\n", ).replace("|", " || ") return content def _generate_table_format(variables_df, tablefmt="grid"): # Break descriptions that are too long variables_df["DESCRIPTION"] = variables_df["DESCRIPTION"].apply( lambda s: "\n".join(tw.wrap(s, 100)) ) content = tabulate( variables_df, headers=variables_df.columns, showindex=False, tablefmt=tablefmt ) return content + "\n"
[docs]def list_modules( source_path: Union[List[str], str] = None, out: Union[IO, str] = None, overwrite: bool = False, verbose: bool = False, force_text_output: bool = False, ): """ Writes list of available systems. If source_path is given and if it defines paths where there are registered systems, they will be listed too. :param source_path: either a configuration file path, folder path, or list of folder path :param out: the output stream or a path for the output file (None means sys.stdout) :param overwrite: if True and out is a file path, the file will be written even if one already exists :param verbose: if True, shows detailed information for each system if False, shows only identifier and path of each system :param force_text_output: if True, list will be written as text, even if command is used in an interactive IPython shell (Jupyter notebook). Has no effect in other shells or if out parameter is not sys.stdout :return: path of generated file, or None if no file was generated. :raise FastPathExistsError: if `overwrite==False` and `out` is a file path and the file exists """ if out is None: out = sys.stdout if isinstance(source_path, str): if pth.isfile(source_path): conf = FASTOADProblemConfigurator(source_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) # As the problem has been configured, # BundleLoader now knows additional registered systems elif pth.isdir(source_path): RegisterOpenMDAOSystem.explore_folder(source_path) else: raise FileNotFoundError(f"Could not find {source_path}") elif isinstance(source_path, Iterable): for folder_path in source_path: if not pth.isdir(folder_path): _LOGGER.warning("SKIPPED %s: folder does not exist.", folder_path) else: RegisterOpenMDAOSystem.explore_folder(folder_path) elif source_path is not None: raise RuntimeError("Unexpected type for source_path") if verbose: cell_list = _get_detailed_system_list() else: cell_list = _get_simple_system_list() if isinstance(out, str): out = pth.abspath(out) if not overwrite and pth.exists(out): raise FastPathExistsError( f"File {out} not written because it already exists. " "Use overwrite=True to bypass.", out, ) make_parent_dir(out) out_file = open(out, "w", encoding="utf-8") else: if ( out == sys.stdout and InteractiveShell.initialized() and not force_text_output and not verbose ): display(HTML(tabulate(cell_list, tablefmt="html"))) return None out_file = out out_file.write(tabulate(cell_list, tablefmt="grid")) out_file.write("\n") if isinstance(out, str): out_file.close() _LOGGER.info("System list written in %s", out) return out return None
def _get_simple_system_list(): cell_list = [[" AVAILABLE MODULE IDENTIFIERS", "MODULE PATH"]] for identifier in sorted(RegisterOpenMDAOSystem.get_provider_ids()): path = BundleLoader().get_factory_path(identifier) cell_list.append([identifier, path]) cell_list.append([" AVAILABLE PROPULSION WRAPPER IDENTIFIERS", "MODULE PATH"]) for identifier in sorted(RegisterPropulsion.get_provider_ids()): path = BundleLoader().get_factory_path(identifier) cell_list.append([identifier, path]) return cell_list def _get_detailed_system_list(): cell_list = [["AVAILABLE MODULE IDENTIFIERS\n============================"]] for identifier in sorted(RegisterOpenMDAOSystem.get_provider_ids()): path = BundleLoader().get_factory_path(identifier) domain = RegisterOpenMDAOSystem.get_provider_domain(identifier) description = RegisterOpenMDAOSystem.get_provider_description(identifier) if description is None: description = "" # We remove OpenMDAO's native options from the description component = RegisterOpenMDAOSystem.get_system(identifier) component.options.undeclare("assembled_jac_type") component.options.undeclare("distributed") cell_content = ( f"IDENTIFIER: {identifier}\n" f"PATH: {path}\n" f"DOMAIN: {domain.value}\n" f"DESCRIPTION: {tw.indent(tw.dedent(description), ' ')}\n" ) if len(list(component.options.items())) > 0: cell_content += component.options.to_table(fmt="grid") + "\n" cell_list.append([cell_content]) cell_list.append( ["AVAILABLE PROPULSION WRAPPER IDENTIFIERS\n========================================"] ) for identifier in sorted(RegisterPropulsion.get_provider_ids()): path = BundleLoader().get_factory_path(identifier) description = RegisterPropulsion.get_provider_description(identifier) if description is None: description = "" cell_content = ( f"IDENTIFIER: {identifier}\n" f"PATH: {path}\n" f"DESCRIPTION: {tw.indent(tw.dedent(description), ' ')}\n" ) cell_list.append([cell_content]) return cell_list
[docs]def write_n2(configuration_file_path: str, n2_file_path: str = None, overwrite: bool = False): """ Write the N2 diagram of the problem in file n2.html :param configuration_file_path: :param n2_file_path: if None, will default to `n2.html` :param overwrite: :return: path of generated file. :raise FastPathExistsError: if overwrite==False and n2_file_path already exists """ if not n2_file_path: n2_file_path = "n2.html" n2_file_path = pth.abspath(n2_file_path) if not overwrite and pth.exists(n2_file_path): raise FastPathExistsError( f"N2-diagram file {n2_file_path} not written because it already exists. " "Use overwrite=True to bypass.", n2_file_path, ) make_parent_dir(n2_file_path) conf = FASTOADProblemConfigurator(configuration_file_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) problem = conf.get_problem() problem.setup() problem.final_setup() om.n2(problem, outfile=n2_file_path, show_browser=False) if InteractiveShell.initialized(): clear_output() _LOGGER.info("N2 diagram written in %s", pth.abspath(n2_file_path)) return n2_file_path
[docs]def write_xdsm( configuration_file_path: str, xdsm_file_path: str = None, overwrite: bool = False, depth: int = 2, wop_server_url: str = None, dry_run: bool = False, ): """ :param configuration_file_path: :param xdsm_file_path: the path for HTML file to be written (will overwrite if needed) :param overwrite: if False, will raise an error if file already exists. :param depth: the depth analysis for WhatsOpt :param wop_server_url: URL of WhatsOpt server (if None, ether.onera.fr/whatsopt will be used) :param dry_run: if True, will run wop without sending any request to the server. Generated XDSM will be empty. (for test purpose only) :return: path of generated file. :raise FastPathExistsError: if overwrite==False and xdsm_file_path already exists """ if not xdsm_file_path: xdsm_file_path = pth.join(pth.dirname(configuration_file_path), "xdsm.html") xdsm_file_path = pth.abspath(xdsm_file_path) if not overwrite and pth.exists(xdsm_file_path): raise FastPathExistsError( "XDSM-diagram file %s not written because it already exists. " "Use overwrite=True to bypass." % xdsm_file_path, xdsm_file_path, ) make_parent_dir(xdsm_file_path) conf = FASTOADProblemConfigurator(configuration_file_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) problem = conf.get_problem() problem.setup() problem.final_setup() fastoad.openmdao.whatsopt.write_xdsm(problem, xdsm_file_path, depth, wop_server_url, dry_run) return xdsm_file_path
def _run_problem( configuration_file_path: str, overwrite: bool = False, mode="run_model", auto_scaling: bool = False, ) -> FASTOADProblem: """ Runs problem according to provided file :param configuration_file_path: problem definition :param overwrite: if True, output file will be overwritten :param mode: 'run_model' or 'run_driver' :param auto_scaling: if True, automatic scaling is performed for design variables and constraints :return: the OpenMDAO problem after run :raise FastPathExistsError: if overwrite==False and output data file of problem already exists """ conf = FASTOADProblemConfigurator(configuration_file_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) problem = conf.get_problem(read_inputs=True, auto_scaling=auto_scaling) outputs_path = pth.normpath(problem.output_file_path) if not overwrite and pth.exists(outputs_path): raise FastPathExistsError( f"Problem not run because output file {outputs_path} already exists. " "Use overwrite=True to bypass.", outputs_path, ) problem.setup() start_time = time() if mode == "run_model": problem.run_model() problem.optim_failed = False # Actually, we don't know else: problem.optim_failed = problem.run_driver() end_time = time() computation_time = round(end_time - start_time, 2) problem.write_outputs() if problem.optim_failed: _LOGGER.error("Optimization failed after %s seconds", computation_time) else: _LOGGER.info("Computation finished after %s seconds", computation_time) _LOGGER.info("Problem outputs written in %s", outputs_path) return problem
[docs]def evaluate_problem(configuration_file_path: str, overwrite: bool = False) -> FASTOADProblem: """ Runs model according to provided problem file :param configuration_file_path: problem definition :param overwrite: if True, output file will be overwritten :return: the OpenMDAO problem after run :raise FastPathExistsError: if overwrite==False and output data file of problem already exists """ return _run_problem(configuration_file_path, overwrite, "run_model")
[docs]def optimize_problem( configuration_file_path: str, overwrite: bool = False, auto_scaling: bool = False ) -> FASTOADProblem: """ Runs driver according to provided problem file :param configuration_file_path: problem definition :param overwrite: if True, output file will be overwritten :param auto_scaling: if True, automatic scaling is performed for design variables and constraints :return: the OpenMDAO problem after run :raise FastPathExistsError: if overwrite==False and output data file of problem already exists """ return _run_problem(configuration_file_path, overwrite, "run_driver", auto_scaling=auto_scaling)
[docs]def optimization_viewer(configuration_file_path: str): """ Displays optimization information and enables its editing :param configuration_file_path: problem definition :return: display of the OptimizationViewer """ conf = FASTOADProblemConfigurator(configuration_file_path) conf._set_configuration_modifier(_PROBLEM_CONFIGURATOR) viewer = OptimizationViewer() viewer.load(conf) return viewer.display()
[docs]def variable_viewer(file_path: str, file_formatter: IVariableIOFormatter = None, editable=True): """ Displays a widget that enables to visualize variables information and edit their values. :param file_path: the path of file to interact with :param file_formatter: the formatter that defines file format. If not provided, default format will be assumed. :param editable: if True, an editable table with variable filters will be displayed. If False, the table will not be editable nor searchable, but can be stored in an HTML file. :return: display handle of the VariableViewer """ if editable: viewer = VariableViewer() viewer.load(file_path, file_formatter) handle = viewer.display() else: variables = DataFile(file_path, formatter=file_formatter) variables.sort(key=lambda var: var.name) table = variables.to_dataframe()[["name", "val", "units", "is_input", "desc"]].rename( columns={"name": "Name", "val": "Value", "units": "Unit", "desc": "Description"} ) table["I/O"] = "OUT" table["I/O"].loc[table["is_input"]] = "IN" del table["is_input"] table.set_index("Name", drop=True, inplace=True) handle = display(HTML(table.to_html())) return handle