TidalPy.Extending.burnman package

Subpackages

Submodules

TidalPy.Extending.burnman.build module

TidalPy.Extending.burnman.build.build_burnman_world(planet_config: dict, verbose: bool = False) Tuple[None, Tuple[None, ...]][source]

Builds a BurnMan planet from a provided configuration dictionary.

Parameters:
  • planet_config (dict) – Dictionary of planet configurations used to initialize layers and the planet.

  • verbose (bool = False) – If True, BurnMan will print more information to console.

Returns:

  • burnman_world (burnman.Planet) – An initialized and built burnman planet class

  • burnman_layers (Tuple[burnman.Layer, …]) – An ordered list of initialized burnman layers

TidalPy.Extending.burnman.build.build_layer(layer_name: str, layer_config: dict, burnman_verbose: str = False) None[source]

Build a Burnman layer

Parameters:
  • layer_name (str) – Name of the layer

  • layer_config (dict) – Dictionary of layer configurations used to initialize the layer

  • burnman_verbose (bool, default = False) – Determines the verboseness of the BurnMan package.

Returns:

layer – An initialized burnman layer

Return type:

burnman.Layer

TidalPy.Extending.burnman.burnman_defaultc module

TidalPy.Extending.burnman.burnman_layer module

TidalPy.Extending.burnman.burnman_world module

TidalPy.Extending.burnman.conversion module

TidalPy.Extending.burnman.defaults module

TidalPy.Extending.burnman.package module

class TidalPy.Extending.burnman.package.Material[source]

Bases: object

class TidalPy.Extending.burnman.package.Mineral[source]

Bases: object

class TidalPy.Extending.burnman.package.burnman[source]

Bases: object

Layer = None
Material = None
Planet = None
TidalPy.Extending.burnman.package.dictionarize_formula(x)[source]
TidalPy.Extending.burnman.package.formula_mass(x)[source]
TidalPy.Extending.burnman.package.material_property(x)[source]