# spacepy.igrf.IGRF

class spacepy.igrf.IGRF

  International Geomagnetic Reference Field model

  Notes

  New in version 0.3.0.

  Methods

  `calcDipoleAxis`() | Calculates dipole axis for initialized time.
  `initialize`(time[, limits]) | Initialize model state to a particular time.

  Data

  calcDipoleAxis()

    Calculates dipole axis for initialized time.

    Populates `moment` and `dipole`.

  initialize(time, limits='warn')

    Initialize model state to a particular time.

    Parameters
      time `datetime`

        Time for which to initialize the model

    Other Parameters
      limits `str`, optional

        Set to `warn` to warn about out-of-range times (default); any other value to error.

  dipole

    Characteristics of dipole (`dict`).

  moment

    Dipole moments (`dict`).