pypsa.Network.export_to_hdf5

pypsa.Network.export_to_hdf5#

Network.export_to_hdf5(path: Path | str, export_standard_types: bool = False, **kwargs: Any) → None#

Export network and components to an HDF store.

Both static and series attributes of components are exported, but only if they have non-default values.

If path does not already exist, it is created.

path may also be a cloud object storage URI if cloudpathlib is installed.

Parameters:

  • path (string) – Name of hdf5 file to which to export (if it exists, it is overwritten)

  • export_standard_types (boolean, default False) – If True, then standard types are exported too (upon reimporting you should then set “ignore_standard_types” when initialising the network).

  • **kwargs – Extra arguments for pd.HDFStore to specify f.i. compression (default: complevel=4)

Examples

>>> n.export_to_hdf5(filename)
Contents