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:
:param overwrite:
"""
if not n2_file_path:
n2_file_path = pth.join(pth.dirname(configuration_file_path),
"n2.html")
n2_file_path = pth.abspath(n2_file_path)
if not overwrite and pth.exists(n2_file_path):
raise FastFileExistsError(
"N2-diagram file %s not written because it already exists. "
"Use overwrite=True to bypass." % n2_file_path,
n2_file_path,
)
make_parent_dir(n2_file_path)
problem = FASTOADProblemConfigurator(configuration_file_path).get_problem()
problem.setup()
problem.final_setup()
om.n2(problem, outfile=n2_file_path, show_browser=False)
_LOGGER.info("N2 diagram written in %s", n2_file_path)
def write_variables(self, data_source: Union[str, IO], variables: VariableList):
root = etree.Element(ROOT_TAG)
for variable in variables:
try:
xpath = self._translator.get_xpath(variable.name)
except FastXpathTranslatorVariableError as exc:
_LOGGER.warning("No translation found: %s", exc)
continue
element = self._create_xpath(root, xpath)
# Set value, units and io
if variable.units:
element.attrib[self.xml_unit_attribute] = variable.units
if variable.is_input is not None:
element.attrib[self.xml_io_attribute] = str(variable.is_input)
# Filling value for already created element
element.text = str(variable.value)
if not isinstance(variable.value, (np.ndarray, Vector, list)):
# Here, it should be a float
element.text = str(variable.value)
elif len(np.squeeze(variable.value).shape) == 0:
element.text = str(np.squeeze(variable.value).item())
else:
element.text = json.dumps(np.asarray(variable.value).tolist())
if variable.description:
element.append(etree.Comment(variable.description))
# Write
tree = etree.ElementTree(root)
make_parent_dir(data_source)
tree.write(data_source, pretty_print=True)
def save(self, filename: str = None):
"""
Saves the current configuration
If no filename is provided, the initially read file is used.
:param filename: file where to save configuration
"""
if not filename:
filename = self._conf_file
make_parent_dir(filename)
with open(filename, "w") as file:
d = tomlkit.dumps(self._conf_dict)
file.write(d)
def copy_resource(package: Package, resource: str, target_path):
"""
Copies the indicated resource file to provided target path.
If target_path matches an already existing folder, resource file will be copied in this folder
with same name. Otherwise, target_path will be the used name of copied resource file
:param package: package as in importlib.resources.read_binary()
:param resource: resource as in importlib.resources.read_binary()
:param target_path: file system path
"""
make_parent_dir(target_path)
if pth.isdir(target_path):
target_path = pth.join(target_path, resource)
with path(package, resource) as source_path:
shutil.copy(source_path, target_path)
def generate_configuration_file(configuration_file_path: str,
overwrite: bool = False):
"""
Generates a sample configuration file.
: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
:raise FastFileExistsError: if overwrite==False and configuration_file_path already exists
"""
if not overwrite and pth.exists(configuration_file_path):
raise FastFileExistsError(
"Configuration file %s not written because it already exists. "
"Use overwrite=True to bypass." % configuration_file_path,
configuration_file_path,
)
make_parent_dir(configuration_file_path)
copy_resource(resources, SAMPLE_FILENAME, configuration_file_path)
_LOGGER.info("Sample configuration written in %s", configuration_file_path)
def write_xdsm(
configuration_file_path: str,
xdsm_file_path: str = None,
overwrite: bool = False,
depth: int = 2,
wop_server_url=None,
api_key=None,
):
"""
:param configuration_file_path:
:param xdsm_file_path:
:param overwrite:
:param depth:
:param wop_server_url:
:param api_key:
:return:
"""
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 FastFileExistsError(
"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)
problem = FASTOADProblemConfigurator(configuration_file_path).get_problem()
problem.setup()
problem.final_setup()
wop = WhatsOpt(url=wop_server_url, login=False)
try:
ok = wop.login(api_key=api_key, echo=False)
except requests.exceptions.ConnectionError:
if not wop_server_url and wop.url == PROD_URL:
used_url = wop.url
# If connection failed while attempting to reach the wop default URL,
# that is the internal ONERA server, try with the external server
try:
wop = WhatsOpt(url=DEFAULT_WOP_URL)
ok = wop.login(api_key=api_key, echo=False)
except requests.exceptions.ConnectionError:
_LOGGER.warning("Failed to connect to %s and %s", used_url,
DEFAULT_WOP_URL)
return
else:
_LOGGER.warning("Failed to connect to %s", wop.url)
return
if ok:
xdsm = wop.push_mda(problem, {
"--xdsm": True,
"--name": None,
"--dry-run": False,
"--depth": depth
})
generate_xdsm_html(xdsm, xdsm_file_path)
else:
wop.logout()
_LOGGER.warning("Could not login to %s", wop.url)
def list_systems(configuration_file_path: str = None,
out: Union[IO, str] = sys.stdout,
overwrite: bool = False):
"""
Writes list of available systems.
If configuration_file_path is given and if it defines paths where there are registered systems,
they will be listed too.
:param configuration_file_path:
:param out: the output stream or a path for the output file
:param overwrite: if True and out is a file path, the file will be written even if one already
exists
:raise FastFileExistsError: if overwrite==False and out is a file path and the file exists
"""
if configuration_file_path:
conf = FASTOADProblemConfigurator(configuration_file_path)
conf.load(configuration_file_path)
# As the problem has been configured, BundleLoader now knows additional registered systems
if isinstance(out, str):
if not overwrite and pth.exists(out):
raise FastFileExistsError(
"File %s not written because it already exists. "
"Use overwrite=True to bypass." % out,
out,
)
make_parent_dir(out)
out_file = open(out, "w")
else:
out_file = out
out_file.writelines([
"== AVAILABLE SYSTEM IDENTIFIERS " + "=" * 68 + "\n", "-" * 100 + "\n"
])
for identifier in sorted(OpenMDAOSystemRegistry.get_system_ids()):
path = BundleLoader().get_factory_path(identifier)
domain = OpenMDAOSystemRegistry.get_system_domain(identifier)
description = OpenMDAOSystemRegistry.get_system_description(identifier)
if description is None:
description = ""
out_file.write(" IDENTIFIER: %s\n" % identifier)
out_file.write(" PATH: %s\n" % path)
out_file.write(" DOMAIN: %s\n" % domain.value)
out_file.write(" DESCRIPTION: %s\n" %
tw.indent(tw.dedent(description), " "))
out_file.write("-" * 100 + "\n")
out_file.write("=" * 100 + "\n")
out_file.writelines([
"\n== AVAILABLE PROPULSION WRAPPER IDENTIFIERS " + "=" * 56 + "\n",
"-" * 100 + "\n"
])
for identifier in sorted(RegisterPropulsion.get_model_ids()):
path = BundleLoader().get_factory_path(identifier)
description = RegisterPropulsion.get_service_description(identifier)
if description is None:
description = ""
out_file.write(" IDENTIFIER: %s\n" % identifier)
out_file.write(" PATH: %s\n" % path)
out_file.write(" DESCRIPTION: %s\n" %
tw.indent(tw.dedent(description), " "))
out_file.write("-" * 100 + "\n")
out_file.write("=" * 100 + "\n")
if isinstance(out, str):
out_file.close()
_LOGGER.info("System list written in %s", out_file)
def list_variables(
configuration_file_path: str,
out: Union[IO, str] = sys.stdout,
overwrite: bool = False,
force_text_output: bool = False,
):
"""
Writes list of variables for the :class:`FASTOADProblem` 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
: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
:raise FastFileExistsError: if overwrite==False and out parameter is a file path and the file
exists
"""
conf = FASTOADProblemConfigurator(configuration_file_path)
problem = conf.get_problem()
problem.setup()
# Extracting inputs and outputs
variables = VariableList.from_problem(problem, get_promoted_names=False)
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])
if isinstance(out, str):
if not overwrite and pth.exists(out):
raise FastFileExistsError(
"File %s not written because it already exists. "
"Use overwrite=True to bypass." % out,
out,
)
make_parent_dir(out)
out_file = open(out, "w")
table_width = MAX_TABLE_WIDTH
else:
if out == sys.stdout and InteractiveShell.initialized(
) and not force_text_output:
# Here we display the variable list as VariableViewer in a notebook
for var in input_variables:
var.metadata["I/O"] = "IN"
for var in output_variables:
var.metadata["I/O"] = "OUT"
df = ((input_variables + output_variables).to_dataframe()[[
"I/O", "name", "desc"
]].rename(columns={
"name": "Name",
"desc": "Description"
}))
display(HTML(df.to_html()))
return
# Here we continue with text output
out_file = out
table_width = min(get_terminal_size().columns, MAX_TABLE_WIDTH) - 1
pd.set_option("display.max_colwidth", 1000)
max_name_length = np.max([
len(name)
for name in input_variables.names() + output_variables.names()
])
description_text_width = table_width - max_name_length - 2
def _write_variables(out_f, variables):
"""Writes variables and their description as a pandas DataFrame"""
df = variables.to_dataframe()
# Create a new Series where description are wrapped on several lines if needed.
# Each line becomes an element of the Series
df["desc"] = [
"\n".join(tw.wrap(s, description_text_width)) for s in df["desc"]
]
new_desc = df.desc.str.split("\n", expand=True).stack()
# Create a Series for name that will match new_desc Series. Variable name will be in front of
# first line of description. An empty string will be in front of other lines.
new_name = [
df.name.loc[i] if j == 0 else "" for i, j in new_desc.index
]
# Create the DataFrame that will be displayed
new_df = pd.DataFrame({"NAME": new_name, "DESCRIPTION": new_desc})
out_f.write(
new_df.to_string(
index=False,
columns=["NAME", "DESCRIPTION"],
justify="center",
formatters={ # Formatters are needed for enforcing left justification
"NAME": ("{:%s}" % max_name_length).format,
"DESCRIPTION": ("{:%s}" % description_text_width).format,
},
)
)
out_file.write("\n")
def _write_text_with_line(txt: str, line_length: int):
""" Writes a line of given length with provided text inside """
out_file.write("-" + txt + "-" * (line_length - 1 - len(txt)) + "\n")
# Inputs
_write_text_with_line(" INPUTS OF THE PROBLEM ", table_width)
_write_variables(out_file, input_variables)
# Outputs
out_file.write("\n")
_write_text_with_line(" OUTPUTS OF THE PROBLEM ", table_width)
_write_variables(out_file, output_variables)
_write_text_with_line("", table_width)
if isinstance(out, str):
out_file.close()
_LOGGER.info("Output list written in %s", out_file)
