AeroMAPS

Initialization module for the AeroMAPS package, which provides the function to create an AeroMAPSProcess.

create_process

create_process(configuration_file=None, custom_models=None, optimisation=False)

Create an AeroMAPS process.

Parameters:

Name	Type	Description	Default
configuration_file	str	Path to the configuration file (default is None).	None
models	dict	Dictionary of additional models to be used. These are merged with the standard models loaded from the configuration file's models.standards list (default is None).	required
optimisation	bool	Whether to enable optimisation (default is False).	False

Returns:

Type	Description
AeroMAPSProcess	An instance of the AeroMAPSProcess class.

Source code in aeromaps/__init__.py

def create_process(
    configuration_file=None,
    custom_models=None,
    optimisation=False,
) -> AeroMAPSProcess:
    """
    Create an AeroMAPS process.

    Parameters
    ----------
    configuration_file : str, optional
        Path to the configuration file (default is None).
    models : dict, optional
        Dictionary of additional models to be used. These are merged with
        the standard models loaded from the configuration file's
        `models.standards` list (default is None).
    optimisation : bool, optional
        Whether to enable optimisation (default is False).

    Returns
    -------
    AeroMAPSProcess
        An instance of the AeroMAPSProcess class.
    """

    return AeroMAPSProcess(
        configuration_file=configuration_file,
        custom_models=custom_models,
        optimisation=optimisation,
    )