Skip to content
Ashley Smith edited this page May 17, 2022 · 17 revisions

This wiki is developer-focussed information about viresclient - users should refer to readthedocs.

viresclient provides access to data from both Swarm (via vires.services) and Aeolus (via aeolus.services). For related packages for Swarm (i.e. space physics), see PyHC (http://heliopython.org) and Magnetic Earth.

viresclient focusses simply on data access (connecting together VirES and the Python data ecosystem, i.e. numpy, pandas, xarray). Further functionality (e.g. visualisation and algorithms) can be provided in other packages and Jupyter notebooks.

Aims:

  • Users shouldn't need to know about file formats & original data/model organisation/implementation
  • Provide access to data structures which support analysis immediately (i.e. pandas etc.)
  • Make it easy to share analyses with others (i.e. share reproducible notebooks)
  • Flexible to easily work together with other libraries
  • Save researchers' time!

For more info, check https://hackmd.io/@swarm/dev/

Clone this wiki locally