Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Jun 14, 2016
1 parent 3db60b4 commit 536315e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Provides
* :ref:`spec` : library: python binding to read SPEC [#]_ data files
* :ref:`prjPySpec` : library: legacy version of **pySpec**, frozen at version 2014.0623.0
* :ref:`eznx` : library: (Easy NeXus) supports writing NeXus [#]_ HDF5 [#]_ files using h5py [#]_
* :ref:`specplot` : command-line tool: plot a SPEC scan to an image file
* :ref:`specplot_gallery` : command-line tool: call **specplot** for all scans in a list of files, makes a web gallery

.. [#] http://certif.com
.. [#] http://nexusformat.org
Expand Down
29 changes: 23 additions & 6 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,26 @@ To install in an alternate location::
Required Libraries
##################

======== =============================
Library URL
======== =============================
h5py http://www.h5py.org
numpy http://numpy.scipy.org/
======== =============================
These libraries are required to write NeXus data files.
They are not required to read SPEC data files.

============= =============================
Library URL
============= =============================
h5py http://www.h5py.org
numpy http://numpy.scipy.org/
============= =============================

Optional Libraries
##################

These libraries are used by the :ref:`specplot <specplot>`
and :ref:`specplot_gallery <specplot_gallery>` modules
of the *spec2nexus* package but are not required
just to read SPEC data files or write NeXus data files.

============= =============================
Library URL
============= =============================
MatPlotLib http://matplotlib.org/
============= =============================

0 comments on commit 536315e

Please sign in to comment.