Skip to content

Commit

Permalink
Merge pull request #9 from andreas-h/patch-1
Browse files Browse the repository at this point in the history
Fix markdown in README
  • Loading branch information
FrancescAlted committed Oct 6, 2016
2 parents 72fca39 + 98a9dfb commit 063124f
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Expand Up @@ -49,7 +49,7 @@ As for Issues, please use the
[tool](https://github.com/spectraphilic/reflexible/issues) at
github.

Direct inquiries may be sent to::
Direct inquiries may be sent to:

John F Burkhart, University of Oslo
[john.burkhart](mailto://john.burkhart@geo.uio.no)
Expand All @@ -58,9 +58,9 @@ Direct inquiries may be sent to::

### GitHub ###

Clone the github repository into a folder in your PYTHONPATH::
Clone the github repository into a folder in your PYTHONPATH:

$ git clone https://github.com/spectraphilic/reflexible.git
$ git clone https://github.com/spectraphilic/reflexible.git

### Sphinx Documentation ###

Expand All @@ -78,9 +78,9 @@ an issue.
An alternative 'BinaryFile' class has been created so one can work
with pure Python. Alone, it is significantly slower than the FortFlex
module, however, if you use the dumpgrid module, significant speedups
can be achieved. For this run::
can be achieved. For this run:

$ python setup.py build_ext --inplace
$ python setup.py build_ext --inplace

This will compile the pflexcy.pyx file into a pflexcy.so module that
can be imported and used by the pf.readgrid function. A series of
Expand All @@ -99,24 +99,24 @@ documentation.

reflexible comes with a suite of test units that you can run in a
series of ways after you compiled the extensions and before you
install it::
install it:

$ PYTHONPATH=. python -c "import reflexible; reflexible.test()"
$ PYTHONPATH=. python -c "import reflexible; reflexible.test()"

or::
or:

$ PYTHONPATH=. python reflexible/tests/all.py
$ PYTHONPATH=. python reflexible/tests/all.py

or using the excellent py.test (recommended for developers)::
or using the excellent py.test (recommended for developers):

$ PYTHONPATH=. py.test
$ PYTHONPATH=. py.test

## Installation

If all is working correctly, then you can install it (you might need
to be superuser here)::
to be superuser here):

$ python setup.py install
$ python setup.py install

And *hopefully* everything works!.

Expand All @@ -127,15 +127,15 @@ a ticket you would add the information about the versions you are
using. You can do that via the `pf.print_versions()`. Here it is an
output example::

$ python -c "import reflexible; reflexible.print_versions()"
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
reflexible version: 0.10.0
NumPy version: 1.9.0
Python version: 2.7.8 |Anaconda 2.1.0 (64-bit)| (default, Aug 21 2014, 18:22:21)
[GCC 4.4.7 20120313 (Red Hat 4.4.7-1)]
Platform: linux2-x86_64
Byte-ordering: little
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
$ python -c "import reflexible; reflexible.print_versions()"
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
reflexible version: 0.10.0
NumPy version: 1.9.0
Python version: 2.7.8 |Anaconda 2.1.0 (64-bit)| (default, Aug 21 2014, 18:22:21)
[GCC 4.4.7 20120313 (Red Hat 4.4.7-1)]
Platform: linux2-x86_64
Byte-ordering: little
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

## Key Tools

Expand Down

0 comments on commit 063124f

Please sign in to comment.