def load(self, conf_file):
"""
Reads the problem definition
:param conf_file: Path to the file to open or a file descriptor
"""
self._conf_file = pth.abspath(
conf_file) # for resolving relative paths
conf_dirname = pth.dirname(self._conf_file)
if pth.splitext(self._conf_file)[-1] == ".toml":
self._serializer = _TOMLSerializer()
_LOGGER.warning(
"TOML-formatted configuration files are deprecated. Please use YAML format."
)
else:
self._serializer = _YAMLSerializer()
self._serializer.read(self._conf_file)
# Syntax validation
with open_text(resources, JSON_SCHEMA_NAME) as json_file:
json_schema = json.loads(json_file.read())
validate(self._serializer.data, json_schema)
# Issue a simple warning for unknown keys at root level
for key in self._serializer.data:
if key not in json_schema["properties"].keys():
_LOGGER.warning(
'Configuration file: "%s" is not a FAST-OAD key.', key)
# Looking for modules to register
module_folder_paths = self._serializer.data.get(KEY_FOLDERS)
if isinstance(module_folder_paths, str):
module_folder_paths = [module_folder_paths]
if module_folder_paths:
for folder_path in module_folder_paths:
folder_path = pth.join(conf_dirname, str(folder_path))
if not pth.exists(folder_path):
_LOGGER.warning("SKIPPED %s: it does not exist.",
folder_path)
else:
RegisterOpenMDAOSystem.explore_folder(folder_path)
# Settings submodels
submodel_specs = self._serializer.data.get(KEY_SUBMODELS, {})
for submodel_requirement, submodel_id in submodel_specs.items():
RegisterSubmodel.active_models[submodel_requirement] = submodel_id
def load(self, conf_file):
"""
Reads the problem definition
:param conf_file: Path to the file to open or a file descriptor
"""
self._conf_file = pth.abspath(
conf_file) # for resolving relative paths
conf_dirname = pth.dirname(self._conf_file)
if pth.splitext(self._conf_file)[-1] == ".toml":
self._serializer = _TOMLSerializer()
_LOGGER.warning(
"TOML-formatted configuration files are deprecated. Please use YAML format."
)
else:
self._serializer = _YAMLSerializer()
self._serializer.read(self._conf_file)
# Syntax validation
with open_text(resources, JSON_SCHEMA_NAME) as json_file:
json_schema = json.loads(json_file.read())
validate(self._serializer.data, json_schema)
# Looking for modules to register
module_folder_paths = self._serializer.data.get(KEY_FOLDERS)
if isinstance(module_folder_paths, str):
module_folder_paths = [module_folder_paths]
if module_folder_paths:
for folder_path in module_folder_paths:
folder_path = pth.join(conf_dirname, str(folder_path))
if not pth.exists(folder_path):
_LOGGER.warning("SKIPPED %s: it does not exist.",
folder_path)
else:
RegisterOpenMDAOSystem.explore_folder(folder_path)
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 FastFileExistsError: 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("Could not find %s" % 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 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:
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