fre.analysis.subtools module

fre.analysis.subtools.install_analysis_package(url, name=None, library_directory=None)

Installs the analysis package.

Args:

url: URL to the github repository for the analysis package. name: String name of the analysis-script package. library_directory: Directory to install the package in.

fre.analysis.subtools.list_plugins(library_directory=None)

Finds the list of analysis scripts.

Args:

library_directory: Directory where the analysis package is installed.

Returns:

List of string plugin names.

fre.analysis.subtools.run_analysis(name, catalog, output_directory, output_yaml, experiment_yaml, library_directory=None)

Runs the analysis script and writes the paths to the created figures to a yaml file.

Args:

name: String name of the analysis script. catalog: Path to the data catalog. output_directory: Path to the output directory. output_yaml: Path to the output yaml. experiment: Path to the experiment yaml. library_directory: Directory where the analysis package is installed.

fre.analysis.subtools.uninstall_analysis_package(name, library_directory=None)

Uninstalls the analysis package.

Args:

name: String name of the analysis-script package. library_directory: Directory where the package was installed.