Data

Tools

Indexes

Applications

Experiments

Open Source Science

viresclient

viresclient is a Python package for easy access to Swarm & Aeolus products as xarray.Dataset

https://github.com/esa-vires/vires-python-client

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

viresclient is a Python package for easy access to Swarm & Aeolus products as xarray.Dataset

Basic Info
Statistics
  • Stars: 21
  • Watchers: 6
  • Forks: 1
  • Open Issues: 12
  • Releases: 34
Created over 7 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.rst 

.. image:: https://img.shields.io/pypi/v/viresclient
   :target: https://pypi.org/project/viresclient/
   :alt: PyPI

.. image:: https://img.shields.io/conda/vn/conda-forge/viresclient
   :target: https://anaconda.org/conda-forge/viresclient
   :alt: Conda

.. image:: https://readthedocs.org/projects/viresclient/badge/?version=latest
    :target: http://viresclient.readthedocs.io/
    :alt: Documentation Status

.. image:: https://zenodo.org/badge/138034133.svg
   :target: https://zenodo.org/badge/latestdoi/138034133

::

  pip install viresclient

::

  conda install -c conda-forge viresclient

viresclient_ is a Python package which connects to a VirES server, of which there are two: *VirES for Swarm* (https://vires.services) and *VirES for Aeolus* (https://aeolus.services), through the WPS_ interface. This package handles product requests and downloads, enabling easy access to data and models from ESA's Earth Explorer missions, Swarm_ and Aeolus_. This service is provided for ESA by EOX_. For enquiries about the service and problems with accessing your account, please email info@vires.services. For help with usage, please email ashley.smith@ed.ac.uk (for Swarm data) or `raise an issue on GitHub`_.

.. _viresclient: https://github.com/ESA-VirES/VirES-Python-Client
.. _WPS: http://www.opengeospatial.org/standards/wps
.. _Swarm: https://earth.esa.int/eogateway/missions/swarm
.. _Aeolus: https://earth.esa.int/eogateway/missions/aeolus
.. _EOX: https://eox.at/category/vires/
.. _`raise an issue on GitHub`: https://github.com/ESA-VirES/VirES-Python-Client/issues

For code recipes and more, see `Swarm Notebooks`_ & `Aeolus Notebooks`_. To start experimenting right away, *viresclient* is installed on the "Virtual Research Environment" (VRE), which is a managed Jupyter-based system provided for ESA by EOX. The service is free and open to all, accessible through your VirES account - check the notebooks to read more and get started.

.. _`Swarm Notebooks`: https://notebooks.vires.services
.. _`Aeolus Notebooks`: https://notebooks.aeolus.services

Data and models are processed on demand on the VirES server - a combination of measurements from any time interval can be accessed. These are the same data that can be accessed by the VirES GUI. *viresclient* handles the returned data to allow direct loading as a single pandas.DataFrame_, or xarray.Dataset_.

.. _pandas.DataFrame: https://pandas.pydata.org/pandas-docs/stable/dsintro.html#dataframe
.. _xarray.Dataset: http://xarray.pydata.org/en/stable/data-structures.html#dataset

.. code-block:: python

 from viresclient import SwarmRequest

 # Set up connection with server
 request = SwarmRequest()
 # Set collection to use
 # - See https://viresclient.readthedocs.io/en/latest/available_parameters.html
 request.set_collection("SW_OPER_MAGA_LR_1B")
 # Set mix of products to fetch:
 #  measurements (variables from the given collection)
 #  models (magnetic model predictions at spacecraft sampling points)
 #  auxiliaries (variables available with any collection)
 # Optionally set a sampling rate different from the original data
 request.set_products(
     measurements=["F", "B_NEC"],
     models=["CHAOS-Core"],
     auxiliaries=["QDLat", "QDLon"],
     sampling_step="PT10S"
 )
 # Fetch data from a given time interval
 # - Specify times as ISO-8601 strings or Python datetime
 data = request.get_between(
     start_time="2014-01-01T00:00",
     end_time="2014-01-01T01:00"
 )
 # Load the data as an xarray.Dataset
 ds = data.as_xarray()

::

 
 Dimensions:           (NEC: 3, Timestamp: 360)
 Coordinates:
 * Timestamp         (Timestamp) datetime64[ns] 2014-01-01 ... 2014-01-01T00:59:50
 Dimensions without coordinates: NEC
 Data variables:
   Spacecraft        (Timestamp)

Owner

  • Name: VirES
  • Login: ESA-VirES
  • Kind: organization

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: ESA-VirES/VirES-Python-Client
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ashley R. A.
    family-names: Smith
    email: ashley.smith@ed.ac.uk
    orcid: 'https://orcid.org/0000-0001-5198-9574'
  - given-names: Martin
    family-names: Pačes
    email: martin.paces@eox.at
  - given-names: Daniel
    family-names: Santillan
    email: daniel.santillan@eox.at
identifiers:
  - type: doi
    value: 10.5281/zenodo.2554162
    description: All versions of the software
repository-code: 'https://github.com/ESA-VirES/VirES-Python-Client'
abstract: >-
  viresclient is a Python package for easy access to
  Swarm & Aeolus products as xarray.Dataset
license: MIT

GitHub Events

Total
  • Create event: 17
  • Release event: 4
  • Issues event: 5
  • Watch event: 4
  • Delete event: 13
  • Issue comment event: 3
  • Push event: 35
  • Pull request event: 23
  • Fork event: 1
Last Year
  • Create event: 17
  • Release event: 4
  • Issues event: 5
  • Watch event: 4
  • Delete event: 13
  • Issue comment event: 3
  • Push event: 35
  • Pull request event: 23
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 315
  • Total Committers: 4
  • Avg Commits per committer: 78.75
  • Development Distribution Score (DDS): 0.454
Past Year
  • Commits: 21
  • Committers: 3
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.095
Top Committers
Name Email Commits
Ashley Smith a****h@e****k 172
Ashley Smith a****h@m****g 91
Martin Paces m****s@e****t 48
Daniel Santillan d****n@e****t 4
Committer Domains (Top 20 + Academic)
eox.at: 2 magneticearth.org: 1 ed.ac.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 months
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • smithara (2)
  • CassandraAuri (1)
  • pacesm (1)
  • databaaz (1)
Pull Request Authors
  • smithara (19)
  • pacesm (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 5,446 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 6
    (may contain duplicates)
  • Total versions: 42
  • Total maintainers: 1
pypi.org: viresclient

A Python client for interacting with a VirES server

  • Versions: 40
  • Dependent Packages: 2
  • Dependent Repositories: 6
  • Downloads: 5,446 Last month
  • Docker Downloads: 0
Rankings
Dependent packages count: 3.2%
Docker downloads count: 3.6%
Average: 5.2%
Dependent repos count: 6.0%
Downloads: 8.0%
Maintainers (1)
smithara
Last synced: 7 months ago
conda-forge.org: viresclient
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 9.3%
Average: 42.8%
Stargazers count: 50.6%
Dependent packages count: 52.4%
Forks count: 58.8%
Last synced: 7 months ago

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v1 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pre-commit/action v2.0.3 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
.github/workflows/test-latest.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite