Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rayosborn committed Dec 22, 2014
1 parent 7d3403c commit 46600ec
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 18 deletions.
8 changes: 5 additions & 3 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,15 @@ more details of the nature of these dependencies in the NeXpy documentation
(http://nexpy.github.io/nexpy).

h5py http://www.h5py.org/
numpy,scipy http://numpy.scipy.org
numpy http://numpy.org

The remote server requires the Pyro4 package.

pyro4 http://pythonhosted.org//Pyro4/

The following environment variable may need to be set

PYTHONPATH --> must include paths to numpy and scipy if installed
in nonstandard place
PYTHONPATH --> must include paths to numpy if installed in a nonstandard place

All of the above are included in the Enthought Python Distribution v7.3.

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,15 @@ more details of the nature of these dependencies in the
[NeXpy documentation](http://nexpy.github.io/nexpy).

* h5py http://www.h5py.org
* numpy,scipy http://numpy.scipy.org
* numpy http://numpy.org

The remote server requires the Pyro4 package.

* pyro4 http://pythonhosted.org//Pyro4/

The following environment variable may need to be set
PYTHONPATH --> paths to numpy,scipy if installed in a nonstandard place

PYTHONPATH --> paths to numpy if installed in a nonstandard place

All of the above are included in the Enthought Python Distribution v7.3.

Expand Down
23 changes: 10 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,23 @@ To install in an alternate location::
Required Libraries
==================

================= =================================================
================= ===================================================
Library URL
================= =================================================
================= ===================================================
h5py http://www.h5py.org
numpy http://numpy.scipy.org/
pyro4 http://pythonhosted.org//Pyro4/
================= =================================================
pyro4 http://pythonhosted.org//Pyro4/ (for remote server)
================= ===================================================

Semantic Versioning
Versioning
-------------------
NeXpy-RO is using `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
This package uses `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.

User Support
------------
Consult the `NeXpy documentation <http://nexpy.github.io/nexpy/>`_ for details
of both NeXpy and NeXpy-RO. If you have any general questions concerning the use
of NeXpy, please address them to the `NeXus Mailing List
Consult the `NeXpy documentation <http://nexpy.github.io/nexpy/>`_ for help. If
you have any general questions concerning the use of this module, please address
them to the `NeXus Mailing List
<http://download.nexusformat.org/doc/html/mailinglist.html>`_. If you discover
any bugs, please submit a `Github issue
<https://github.com/nexpy/nexusformat/issues>`_, preferably with relevant
Expand All @@ -58,7 +58,4 @@ The `NeXus format <http://www.nexusformat.org>`_ for neutron, x-ray and muon
data is developed by an international collaboration under the supervision of the
`NeXus International Advisory Committee <http://wiki.nexusformat.org/NIAC>`_.
The Python tree API used in NeXpy was originally developed by Paul Kienzle, who
also wrote the standard Python interface to the NeXus C-API. The original
version of NeXpy was initially developed by Boyana Norris, Jason Sarich, and
Daniel Lowell, and Ray Osborn using wxPython, and formed the inspiration
for the current PySide version.
also wrote the standard Python interface to the NeXus C-API.

0 comments on commit 46600ec

Please sign in to comment.