Reference

echaim.density_profile(lats, lons, alts, dt, storm=False, precip=True, dregion=True)

Calculate altitude profile of electron density.

Parameters
  • lats (ndarray) – Array of latitudes in [deg].

  • lons (ndarray) – Array of longitudes in [deg].

  • alts (ndarray) – Array of altitudes in [km].

  • dt (datetime | Collection) – A single datetime object or a sequence of datetime objects.

  • storm (bool, default: False) – Enable model of NmF2 storm perturbation (not always available).

  • precip (bool, default: True) – Enable precipitation model.

  • dregion (bool, default: True) – Enable D-region model.

Return type

ndarray

Returns

2D numpy array with dimensions [len(lats) x len(alts)].

echaim.density_path(lats, lons, alts, dt, storm=False, precip=True, dregion=True)

Calculate electron density on the specified path.

Parameters
  • lats (ndarray) – Array of latitudes in [deg].

  • lons (ndarray) – Array of longitudes in [deg].

  • alts (ndarray) – Array of altitudes in [km].

  • dt (datetime | Collection) – A single datetime object or a sequence of datetime objects.

  • storm (bool, default: False) – Enable model of NmF2 storm perturbation (not always available).

  • precip (bool, default: True) – Enable precipitation model.

  • dregion (bool, default: True) – Enable D-region model.

Return type

ndarray

Returns

1D numpy array of shape len(lats).

echaim.nmf2(lats, lons, dt)

Calculate NmF2 index.

Parameters
  • lats (ndarray) – Array of latitudes in [deg].

  • lons (ndarray) – Array of longitudes in [deg].

  • dt (datetime | Collection) – A single datetime object or a sequence of datetime objects.

Return type

ndarray

Returns

1D numpy array with shape len(lats).

echaim.nmf2_storm(lats, lons, dt)

Calculate NmF2 index using storm perturbation model.

Parameters
  • lats (ndarray) – Array of latitudes in [deg].

  • lons (ndarray) – Array of longitudes in [deg].

  • dt (datetime | Collection) – A single datetime object or a sequence of datetime objects.

Return type

ndarray

Returns

1D numpy array with shape len(lats).

echaim.hmf2(lats, lons, dt)

Calculate HmF2 index.

Parameters
  • lats (ndarray) – Array of latitudes in [deg].

  • lons (ndarray) – Array of longitudes in [deg].

  • dt (datetime | Collection) – A single datetime object or a sequence of datetime objects.

Return type

ndarray

Returns

1D numpy array with shape len(lats).

echaim.hmf1(lats, lons, dt)

Calculate HmF1 index.

Parameters
  • lats (ndarray) – Array of latitudes in [deg].

  • lons (ndarray) – Array of longitudes in [deg].

  • dt (datetime | Collection) – A single datetime object or a sequence of datetime objects.

Return type

ndarray

Returns

1D numpy array with shape len(lats).