pterasoftware.load()

pterasoftware.load(
path: str | Path,
max_size: int | None = None,
) → object

Loads a Ptera Software object from a JSON file.

If the path ends with “.json.gz”, the input is gzip decompressed automatically.

The file records an internal serialization format version. A file is accepted only when that format version matches the running code’s exactly, and there is no migration of files written under a different format version. A mismatch raises a ValueError reporting the file’s format version and the running code’s. To read the file, run a build of Ptera Software whose format version matches the file’s.

Parameters:

  • path – The file path to load from.

  • max_size – The maximum decompressed size in bytes for gzip files. If None, the default of 4 GB is used. Set this to a larger value if loading very large simulation results. Only applies to “.json.gz” files.

Returns:

The deserialized Ptera Software object.