Skip to content

Overview of risk.params

The risk.params module manages and exports analysis parameters, supporting inspection, saving, and sharing to improve reproducibility. Note: Reloading a RISK instance from a saved parameter file is not currently supported.

Loading Parameters

The load() method imports parameters from the running RISK instance. Any np.ndarray values are converted to lists for easier serialization.

Returns: dict: A dictionary containing the processed parameters.

loaded_params = risk.params.load()

Exporting Parameters

Export RISK analysis parameters—from network loading to visualization—in common formats for downstream use or sharing.

Export to CSV

Exports the parameter dictionary to a .csv file.

Parameters:

  • filepath (str): The path where the file will be saved.
risk.params.to_csv(filepath="./data/csv/params/michaelis_2023.csv")

Export to JSON

Exports the parameter dictionary to a .json file. The hierarchical structure is preserved.

Parameters:

  • filepath (str): The path where the file will be saved.
risk.params.to_json(filepath="./data/json/params/michaelis_2023.json")

Export to Text

Exports the parameter dictionary to a plain .txt file in human‑readable format.

Parameters:

  • filepath (str): The path where the file will be saved.
risk.params.to_txt(filepath="./data/txt/params/michaelis_2023.txt")

These export functions allow parameters to be shared and archived. For downstream processing, combine them with summary exports from:

  • graph.summary.to_csv()
  • graph.summary.to_json()
  • graph.summary.to_txt()

For an interactive example showing how these parameters fit into a full RISK workflow, see tutorial.html or download the tutorial notebook and data. You can also launch the Quickstart notebook on Binder to explore the workflow without local installation.