CoolDwarf.model package

Subpackages

• CoolDwarf.model.dsep package
  • Submodules
  • CoolDwarf.model.dsep.dsep module
    • parse_dsep_MOD_file()
  • Module contents
• CoolDwarf.model.mesa package
  • Submodules
  • CoolDwarf.model.mesa.mesa module
    • Dependencies
    • Example usage
    • parse_mesa_MOD_file()
  • Module contents

Submodules

CoolDwarf.model.model module

model.py – General model retreival function for CoolDwarf

This module contains the get_model function, which is used to retrieve the appropriate model object based on the format of the model file.

Dependencies

• pandas

• CoolDwarf.model.mesa

• CoolDwarf.model.dsep

Example usage

>>> from CoolDwarf.model.model import get_model
>>> model = get_model("path/to/model/file", "mesa")
>>> print(model)

CoolDwarf.model.model.get_model(path: str, format: str) → DataFrame

This function is used to retrieve the appropriate model object based on the format of the model file. Available formats are: - mesa: MESA MOD files - dsep: DSEP MOD files

Parameters:

pathstr

Path to the model file

formatstr

Format of the model file. Available formats include: mesa for MESA MOD files, dsep for DSEP MOD files.

Returns:

modelpd.DataFrame

DataFrame containing the model data

Raises:

SSEModelError

If the format is not recognized

Module contents