Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
smithara committed Apr 8, 2019
1 parent 0c6e77b commit 4fd8ec2
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
6 changes: 5 additions & 1 deletion docs/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@ Some links where you can read more about VirES:
- `VirES web service`_
- `Swarm DQW slides about viresclient`_
- `EOX blog posts`_
- `Swarm mission`_

If you have encountered a bug or have a feature request, the preferred option is to raise an issue on GitHub (https://github.com/ESA-VirES/VirES-Python-Client/issues). Otherwise please send an email to info@vires.services

How to acknowledge VirES
------------------------

You can reference ``viresclient`` directly using the DOI of our zenodo_ record.
You can reference ``viresclient`` directly using the DOI of our zenodo_ record. VirES uses data from a number of different sources so please also acknowledge these appropriately.

.. _`VirES web service`: https://vires.services/
.. _`Swarm DQW slides about viresclient`: https://github.com/smithara/viresclient_examples/blob/master/viresclient_SwarmDQW8.pdf
.. _`EOX blog posts`: https://eox.at/category/vires/
.. _zenodo: https://doi.org/10.5281/zenodo.2554163
.. _`Swarm mission`: https://earth.esa.int/web/guest/missions/esa-operational-eo-missions/swarm
18 changes: 9 additions & 9 deletions docs/readme.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Introduction
============

This is the documentation for the ``viresclient`` Python package. This is a tool which connects to a VirES_ server through the WPS_ interface and handles product requests and downloads.
This is the documentation for the ``viresclient`` Python package. This is a tool which connects to a VirES_ server through the WPS_ interface and handles product requests and downloads. This enables easy access to ESA's Swarm mission data and models. If you would like access (a user account is required) or need help, please email info@vires.services

.. _VirES: https://vires.services
.. _WPS: http://www.opengeospatial.org/standards/wps
Expand All @@ -23,22 +23,22 @@ A repository of example notebooks can be found at https://github.com/smithara/vi
Installation
------------

Python ≥ 3.5 is required for full support (since cdflib requires ≥ 3.5).
Linux/Unix and Python ≥ 3.5 is required for full support (since cdflib requires ≥ 3.5).

Python 3.4 can also be used, but conversion from CDF to pandas/xarray is not supported - you can still download and save CDF files - :meth:`viresclient.ReturnedData.to_file`, or download as CSV files and convert to pandas - :meth:`viresclient.ReturnedData.as_dataframe`. (Partial?) support for 2.7 and 3.4 could be added in the future, but their usage is not recommended (https://python3statement.org/).
Python 3.4 can also be used, but conversion from CDF to pandas/xarray is not supported - you can still download and save CDF files - :meth:`viresclient.ReturnedData.to_file`, or download as CSV files and convert to pandas - :meth:`viresclient.ReturnedData.as_dataframe`.

It can currently be installed with::

pip install viresclient

Dependencies::

Jinja2
pandas
cdflib
tables
tqdm
xarray
Jinja2 ≥ 2.10.0
pandas ≥ 0.18.0
cdflib = 0.3.9
tables ≥ 3.4.4
tqdm ≥ 4.23.0
xarray ≥ 0.10.0

There is an unresolved bug with Windows support - see here_.

Expand Down

0 comments on commit 4fd8ec2

Please sign in to comment.