Skip to content

Commit

Permalink
fix script and add install option
Browse files Browse the repository at this point in the history
  • Loading branch information
cpetrich committed Dec 20, 2015
1 parent 8d5a2fa commit 8af391a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
12 changes: 9 additions & 3 deletions README.rst
Expand Up @@ -14,7 +14,7 @@ Documentation is available at `<https://rawdatx.readthedocs.org/>`_.
Installation
============

Make sure the following is installed:
The following prerequisites need to be installed:

* Python 2.7, 3.4, or 3.5
* numpy 1.9 or higher
Expand All @@ -25,10 +25,13 @@ optionally (recommended):
* lxml
* asteval

Then install rawdatx with:

The easiest way to install rawdatx is through pip:
``pip install rawdatx``

Alternatively, download the latest version from the repository
`<https://github.com/cpetrich/rawdatx>`_ and install with
``python setup.py install``.

Usage
=====

Expand Down Expand Up @@ -87,3 +90,6 @@ The XML Definition File (``data_map.xml``) may look like this:
</group>
</measurements>
See also examples and test files in the repository at
`<https://github.com/cpetrich/rawdatx>`_.
13 changes: 9 additions & 4 deletions docs/index.rst
Expand Up @@ -11,7 +11,7 @@ in a single XML Definition File that also serves as documentation.
Installation
------------

Make sure the following is installed:
The following prerequisites need to be installed:

* Python 2.7, 3.4, or 3.5
* numpy 1.9 or higher
Expand All @@ -22,16 +22,19 @@ optionally (recommended):
* lxml
* asteval

Then install rawdatx with:

The easiest way to install rawdatx is through pip:
``pip install rawdatx``

Alternatively, download the latest version from the repository
`<https://github.com/cpetrich/rawdatx>`_ and install with
``python setup.py install``.

Usage
-----

To convert a TOA5 file to XLSX, run the following script::

import rawdatx.read_TOA5 as read_TOA5
import rawdatx.read_TOA5 as read_raw_data
import rawdatx.process_XML as process_XML
config = './config.cfg'
Expand Down Expand Up @@ -84,6 +87,8 @@ The XML Definition File (``data_map.xml``) may look like this:
</group>
</measurements>
See also examples and test files in the repository at
`<https://github.com/cpetrich/rawdatx>`_.

Background
==========
Expand Down

0 comments on commit 8af391a

Please sign in to comment.