enlilviz package

Submodules

enlilviz.enlil module

Main enlil data module.

class enlilviz.enlil.Enlil(ds)

Bases: object

An Enlil model run.

This is a class for storing the 2D slices and satellite data contained within the post-processed files. There are extra methods added to make working with the data easier.

Parameters:ds (xarray.Dataset) – Dataset read in from Enlil netcdf output files.
earth_times

Satellite times for time series plots.

get_satellite_data(satellite, var, coord=None)

Get the time series data from the requested satellite.

Parameters:
  • satellite (str) – Satellite of interest.
  • var (str) – Variable of interest.
  • coord (str, optional) – Coordinate of interest if the variable is a vector quantity. (r, lon, lat)
Returns:

Time series of data.
Return type:

xarray.DataArray
get_satellite_position(satellite, time)

Returns the position of the satellite.

Parameters:
  • satellite (str) – Satellite of interest.
  • time (datetime-like) – Time of interest. Looks for nearest time.
Returns:

  • r (float) – Radial position of satellite (AU)
  • lat (float) – Latitudinal position of the satellite (deg).
  • lon (float) – Longitudinal position of the satellite (deg).
get_slice(var, slice_plane, time=None)

Get a 2D slice of data.

Parameters:
  • var (str) – Variable of interest.
  • slice_plane (str) – Slicing plane of the data (r, lat, lon). Note that a slice in lon, will return data with r/lat coordinates.
  • time (datetime-like, optional) – Time of interest. If left out, all times will be returned.
Returns:

Data sliced along a plane.
Return type:

xarray.DataArray
lat

Latitudinal coordinate (deg).

lon

Longitudinal coordinate (deg).

r

Radial coordinate (AU).

times

Data times for slice plots.

class enlilviz.enlil.Evolution(ds)

Bases: object

A temporal Evolution Enlil output file.

This is a class for storing and accessing the temporal data from specific satellite/object locations requested during the Enlil model run. There are extra methods added to make working with the data easier.

Parameters:ds (xarray.Dataset) – Dataset read in from Enlil netcdf output files.
earth_times

Satellite times for time series plots.

get_position(time)

Returns the position of the satellite.

Parameters:time (datetime-like) – Time of interest. Looks for nearest time.
Returns:
  • r (float) – Radial position of satellite (AU)
  • lat (float) – Latitudinal position of the satellite (deg).
  • lon (float) – Longitudinal position of the satellite (deg).
get_satellite_data(satellite, var, coord=None)

Get the time series data from the requested satellite.

Parameters:
  • satellite (str) – Satellite of interest.
  • var (str) – Variable of interest.
  • coord (str, optional) – Coordinate of interest if the variable is a vector quantity. (r, lon, lat)
Returns:

Time series of data.
Return type:

xarray.DataArray
times

Times within the dataset.

There are no slices in Evolution files, so this method simply returns all satellite times.

enlilviz.io module

Input routines for reading Enlil netcdf files.

enlilviz.io.load_example()

Loads example data that can be used for demonstration and development.

Returns:An Enlil class representing the example dataset.
Return type:enlil.Enlil
enlilviz.io.read_enlil2d(filename)

Load a 2D post-processed Enlil file into an Enlil object.

Parameters:filename (str) – netcdf Enlil post-processed output file Example: wsa_enlil.latest.suball.nc
Returns:An Enlil class representing the loaded file.
Return type:enlil.Enlil
enlilviz.io.read_evo(filename)

Load an evo post-processed Enlil file into an Evolution object.

Parameters:filename (str) – netcdf Enlil post-processed output file Example: evo.earth.nc
Returns:An Evolution class representing the loaded file.
Return type:enlil.Evolution

Module contents

Top-level package for enlilviz.

enlilviz.read_enlil2d(filename)

Load a 2D post-processed Enlil file into an Enlil object.

Parameters:filename (str) – netcdf Enlil post-processed output file Example: wsa_enlil.latest.suball.nc
Returns:An Enlil class representing the loaded file.
Return type:enlil.Enlil
enlilviz.read_evo(filename)

Load an evo post-processed Enlil file into an Evolution object.

Parameters:filename (str) – netcdf Enlil post-processed output file Example: evo.earth.nc
Returns:An Evolution class representing the loaded file.
Return type:enlil.Evolution