magni.cs.phase_transition.io module

Module providing input/output functionality for stored phase transitions.

Routine listings

load_phase_transition(path, label=’default’)
Load the coordinates of a phase transition from a HDF5 file.
magni.cs.phase_transition.io.load_phase_transition(path, label='default', delta=None)[source]

Load the coordinates of a phase transition from a HDF5 file.

This function is used to load the phase transition from the output file generated by magni.cs.phase_transition.determine.

Parameters:
  • path (str) – The path of the HDF5 file where the phase transition is stored.
  • label (str) – The label assigned to the phase transition (the default is ‘default’).
  • delta (ndarray) – The undersampling ratio values to use (the default is None which implies that a uniform spacing of values in the interval (0,1] is assumed.)
Returns:

  • delta (ndarray) – The delta values of the phase transition points.
  • rho (ndarray) – The rho values of the phase transition points.

See also

magni.cs.phase_transition.determine()
Phase transition determination.
magni.cs.phase_transition.plotting()
Phase transition plotting.

Examples

An example of how to use this function is provided in the examples folder in the cs-phase_transition.ipynb ipython notebook file.