CoolDwarf.EOS package

Subpackages

• CoolDwarf.EOS.ChabrierDebras2021 package
  • Submodules
  • CoolDwarf.EOS.ChabrierDebras2021.EOS module
    • Dependencies
    • Example usage
    • CH21EOS
      • CH21EOS.TRange
      • CH21EOS.check_forward_params()
      • CH21EOS.energy()
      • CH21EOS.energy_torch()
      • CH21EOS.parse_table()
      • CH21EOS.pressure()
      • CH21EOS.rhoRange
  • Module contents
• CoolDwarf.EOS.invert package
  • Submodules
  • CoolDwarf.EOS.invert.EOSInverter module
    • Dependencies
    • Example usage
    • Inverter
      • Inverter.temperature_density()
  • Module contents

Submodules

CoolDwarf.EOS.EOS module

EOS.py – General EOS retreival function for CoolDwarf

This module contains the get_eos function, which is used to retrieve the appropriate EOS object based on the format of the EOS table.

Dependencies

• CoolDwarf.EOS.ChabrierDebras2021.EOS

• CoolDwarf.err

Example usage

>>> from CoolDwarf.EOS.EOS import get_eos
>>> eos = get_eos("path/to/eos/table", "CD21")

CoolDwarf.EOS.EOS.get_eos(path: str, format: str)

This function is used to retrieve the appropriate EOS object based on the format of the EOS table. Available formats are: - CD21: Chabrier Debras 2021 EOS tables

Parameters:

pathstr

Path to the EOS table

formatstr

Format of the EOS table. Available formats include: CD21 for Chabrier Debras 2021 EOS tables.

Returns:

EOSEOS

EOS object for the given EOS table

Raises:

EOSFormatError

If the format is not recognized

Module contents