Examples (examples)

Functions:

json_to_dict(basename)	Load a json file into a dict.
load_example_dict(name)	Load a dictionary of data
load_example_lnpimasked(name)	Load an example file
lj_sup_example()	Create an Example instance for a Lennard-Jones fluid (subcritical)
lj_sub_example()	Create an Example instance for a Lennard-Jones fluid (subcritical)
ljmix_sup_example()	Create an Example instance for a Lennard-Jones mixture (supercritical).
hsmix_example()	Create an Example instance for a hard-sphere mixture.

Classes:

ExampleDict	Example dict
Example(ref, phase_creator, build_phases)	Dataclass to hold example data.

lnpy.examples.json_to_dict(basename)

Load a json file into a dict.

All files names are relative to ‘lnpy/data/’

Parameters:

basename (string) – Name of file to load in ‘lnpy/data’ directory.

Returns:

output (dict)

class lnpy.examples.ExampleDict

Bases: TypedDict

Example dict

lnpy.examples.load_example_dict(name)

Load a dictionary of data

Parameters:

name ({'lj_sub', 'lj_sup', 'ljmix_sup', 'hsmix', 'watermof})

lnpy.examples.load_example_lnpimasked(name)

Load an example file

Parameters:

name ({'lj_sub', 'lj_sup', 'ljmix_sup', 'hsmix', 'watermof})

class lnpy.examples.Example(ref, phase_creator, build_phases)

Bases: object

Dataclass to hold example data.

Attributes:

ref	Reference state lnPiMasked.
phase_creator	PhaseCreator instance
build_phases	Callable to build phases.

Methods:

to_dict()	Transform class to dictionary.
unpack([keys])	Unpack keys.

ref

Reference state lnPiMasked.

phase_creator

PhaseCreator instance

build_phases

Callable to build phases.

to_dict()

Transform class to dictionary.

unpack(keys=None)

Unpack keys.

lnpy.examples.lj_sup_example()

Create an Example instance for a Lennard-Jones fluid (subcritical)

lnpy.examples.lj_sub_example()

Create an Example instance for a Lennard-Jones fluid (subcritical)

lnpy.examples.ljmix_sup_example()

Create an Example instance for a Lennard-Jones mixture (supercritical).

lnpy.examples.hsmix_example()

Create an Example instance for a hard-sphere mixture.