Merge pull request #530 from dstansby/v0.5.3

v0.5.3 backports

Author: dstansby

CHANGES.rst

@@ -4,6 +4,17 @@ Version 0.5.2
 New features
 ^^^^^^^^^^^^
 
+- Lots of small documentation updates.
+- `.data.helios.distparams` now has an extra ``'data_rate'`` column, which
+  determines whether a given distribution function was transmitted in high or
+  low data mode. :issue:`529`
+
+Version 0.5.2
+-------------
+
+New features
+^^^^^^^^^^^^
+
 - The new HelioPy logo has been added to the documentation.
   :issue:`448`, :issue:`447`
 

README.md

@@ -1,7 +1,9 @@
 # HelioPy
 
-A python library for Space Physics. The primary goal of this python package is
-to make it really easy to import common data sets used in Space Physics.
+A python library for heliospheric and planetary Physics.
+The primary goal of HelioPy is to provide a set of tools to download and read
+in data, and to carry out other common data processing tasks.
+
 Full documentation can be found [here](http://docs.heliopy.org/).
 
 A quick example shows how easy it is to import and view data:

artwork/logo_circle.png

@@ -30,7 +30,7 @@
 html_sidebars = {'**': ['docsidebar.html']}
 
 # Pretend these modules exits so readthedocs builds
-MOCK_MODULES = ['spiceypy']
+MOCK_MODULES = []
 for mod_name in MOCK_MODULES:
     sys.modules[mod_name] = mock.Mock()
 
@@ -64,6 +64,7 @@
 
 
 sphinx_gallery_conf = {
+    'default_thumb_file': os.path.abspath(os.path.join('..', '..', 'artwork', 'logo_circle.png')),
     'examples_dirs': '../../examples',
     'gallery_dirs': 'auto_examples',
     'backreferences_dir': False,

artwork/logo_circle.svg

@@ -22,7 +22,12 @@ own sub-module:
    ulysses
    wind
 
-There is also other modules for downloading SPICE kernels and sunspot number
+Each mission does not have a complete set of data import methods, but the goal
+of HelioPy is to be as complete as possible. If you want to import a data set
+that is not yet supported please open an issue on the bug tracker at
+https://github.com/heliopython/heliopy/issues
+
+There are also modules for downloading SPICE kernels and sunspot number
 data:
 
 .. toctree::

doc/source/conf.py

@@ -5,7 +5,7 @@ HelioPy is built on the Python programming language. The easiest way to install
 Python with the various required scientific python modules is to use Anaconda.
 Installation instructions can be found `here <https://docs.continuum.io/anaconda/install/>`_.
 
-The supported versions of python are 3.5 and 3.6.
+The minimum supported version of python is python 3.6.
 
 Once you have a Python distribution installed, HelioPy can be installed using
 either conda::
@@ -21,13 +21,14 @@ Optional dependencies
 
 HDF file reader/writer
 ^^^^^^^^^^^^^^^^^^^^^^
-Saving data to hdf files for quicker access requires PyTables.
-(see :ref:`sphx_glr_auto_examples_fast_file_loading.py` for more information)
+Saving data to hdf files for quicker access requires the *PyTables* python
+package. (see :ref:`sphx_glr_auto_examples_fast_file_loading.py`
+for more information)
 
 CDF Library
 ^^^^^^^^^^^
-Reading in any data that is stored in .cdf files requires an installation of
-the CDF library: https://cdf.gsfc.nasa.gov/
+Reading in any data that is stored in .cdf files requires a local installation
+of the CDF library: https://cdf.gsfc.nasa.gov/
 
 SPICE Toolkit
 ^^^^^^^^^^^^^
@@ -44,4 +45,4 @@ https://github.com/heliopython/heliopy/. To install from source follow these ste
 3. ``cd heliopy``
 4. ``pip install .``
 
-This will install HelioPy from source and it's required dependancies.
+This will install HelioPy from source.

doc/source/data/index.rst

@@ -2,8 +2,8 @@
 HelioPy Documentation
 #####################
 
-HelioPy is a free and open source set of tools for automatically downloading
-and reading in space physics timeseries data to python.
+HelioPy is a free and open source set of tools for heliopsheric and planetary
+physics. For more information see the module documentation below.
 
 Getting started
 ===============

doc/source/guide/installing.rst

@@ -18,7 +18,7 @@
 ###############################################################################
 # Load the solar orbiter spice kernel. HelioPy will automatically fetch the
 # latest kernel
-orbiter_kernel = spicedata.get_kernel('solar orbiter 2020')
+orbiter_kernel = spicedata.get_kernel('solo_2020')
 spice.furnish(orbiter_kernel)
 orbiter = spice.Trajectory('Solar Orbiter')
 

doc/source/index.rst

@@ -399,9 +399,9 @@ def distparams(probe, starttime, endtime, verbose=False):
             todays_params = todays_params.set_index('Time', drop=False)
             # Convert columns to numeric types
             todays_params = todays_params.apply(pd.to_numeric, errors='ignore')
+            todays_params['Time'] = pd.to_datetime(todays_params['Time'])
             if use_hdf:
                 todays_params.to_hdf(hdffile, key='distparams', mode='w')
-
         paramlist.append(todays_params)
         starttime += timedelta(days=1)
 
@@ -453,6 +453,7 @@ def distparams_single(probe, year, doy, hour, minute, second):
     distparams['minus'] = int(flags[3])
     # 0 = no instrument, 1 = i1a, 2 = I3
     distparams['ion_instrument'] = int(flags[4])
+    distparams['data_rate'] = 1 if ('hdm' in f.name) else 0
 
     # 2 lines of Helios location information
     location = f.readline().split()