Direct Entries

The base class for all direct entries is DirectEntry.

class ionworkspipeline.direct_entries.DirectEntry(parameters, source)

A pipeline element that directly provides a set of parameters.

Parameters

parametersdict

A dictionary of parameters.

sourcestr

The source of the pipeline element, e.g. a reference to a paper or a description of the method used to generate the parameters.

Extends: ionworkspipeline.pipeline.PipelineElement

run(parameter_values)

Returns the parameters provided to the constructor.

A useful function for creating direct entries from values stored in JSON format is:

ionworkspipeline.direct_entries.from_json(file_path)

Reads parameters from a JSON file and returns a DirectEntry object.

Parameters

file_pathstr

The path to the JSON file.

Returns

DirectEntry

The DirectEntry object with parameters read from the JSON file.

The following direct entries are available:

• Exchange-current density functions
  • arrhenius_butler_volmer_exchange_current_density()
• Particle Diffusivity Functions
  • arrhenius_particle_diffusivity()
• Thermal Direct Entries
  • temperatures()
  • zero_entropic_change()
  • zero_activation_energy()
• Electrolyte Direct Entries
  • constant_electrolyte()
  • nyman_electrolyte()
  • landesfeind_electrolyte()
  • arrhenius_electrolyte_diffusivity()
  • arrhenius_electrolyte_conductivity()
• Miscellaneous Direct Entries
  • standard_defaults()
  • one_cm2_cell()
  • bruggeman()
  • spm_defaults()
  • lithium_metal_anode()
  • sei_defaults()
  • li_plating_defaults()
  • mechanical_degradation_defaults()