geopulse.earth.library

Built-in 1-D Earth-model registry.

Each entry maps a short name to a top-down stack of ConductivityLayer objects. Every model cites the source paper in its comment; values marked TODO(PI) need PI verification against the primary reference before publication.

References

[1]

Boteler, D. H., et al. (Various dates). Québec regional 1-D conductivity models used for GIC simulation.

[2]

Fernberg, P. (2012). One-Dimensional Earth Resistivity Models for Selected Areas of Continental United States and Alaska. EPRI Technical Update 1026430.

Functions

get_model(name)	Instantiate a named built-in Earth model.
list_models()	Return the sorted list of registered built-in model names.

geopulse.earth.library.get_model(name)

Instantiate a named built-in Earth model.

Parameters:

name (str) – Model name from list_models().

Return type:

EarthModel

Returns:

EarthModel – A ready-to-use Layered1D instance.

Raises:

KeyError – If name is not registered.

geopulse.earth.library.list_models()

Return the sorted list of registered built-in model names.

Return type:

list[str]

Returns:

list of str – Alphabetical model names.