Skip to content

Commit

Permalink
Introduction chapter simplified and updated
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescAlted committed Nov 11, 2016
1 parent 5e29b44 commit 5d63115
Showing 1 changed file with 19 additions and 49 deletions.
68 changes: 19 additions & 49 deletions doc/source/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
.. _introduction:


************
Introduction
************
Expand All @@ -18,70 +15,43 @@ Current development activities are focused on improved generality and
handling of FLEXPART output in all possible run configurations, with
and without deposition, forward, backward, or otherwise.

.. _getting-reflexible:

Getting reflexible
=================
Please contact: `John F. Burkhart <jfburkhart@gmail.com>`_

First, make sure you also have the dependencies installed:
- numpy
- matplotlib
- basemap (matplotlib toolkit)
- f2py (to build FortFlex)
- netCDF4 (*not* python-netcdf)
- PIL

Note the easiest way I've found to deal with the dependencies is to
use one of 'complete distributions' such as `Enthought
<http://www.enthought.com>`_ or the `python(xy)
<http://www.pythonxy.com>`_ or ideally `Anaconda
<http://www.continuum.io>`_. For Ubuntu you can pretty easily just
install the required packages. For the netcdf, we found it easiest to
use the science-meteorology-dev meta package and use pip to install
netcdf4-python.

Once you've installed all the dependencies, you can get the code from either
sources below.

GitHub
------

The code is available to the public at `github
<https://github.com/spectraphilic/reflexible>`_.
<https://github.com/spectraphilic/reflexible>`_. You can easily clone
the git repository::

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

The `reflexible <http://pypi.python.org/pypi/reflexible>`_ code is
also posted to pypi, but this is more likely to fall out of date.
Build and test
==============

It should simply be a matter of changing the repo directory and running
setup.py::

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

.. _email-list:
and then run the tests with::

Mailing List
============

There is a mailing list for the project set up at with
sourceforge. You can subscribe to the `reflexible
<https://lists.sourceforge.net/lists/listinfo/reflexible-users>`_ list
for user discussions.
$ pytest

.. _installation:
If the test suite pass, you can proceed with installation.

Installation
============

If all is working correctly, and you have all the required
dependencies, then it should simply be a matter of running setup.py::
It should simply be a matter of running::

$ python setup.py install

python setup.py build
Quick install
=============

and then install it (you might need to be superuser here)::
You may also want to install the package in one single shot (no testing
though!) with::

python setup.py install
$ pip install git+https://github.com/spectraphilic/reflexible.git

And *hopefully* everything works!.

Expand Down

0 comments on commit 5d63115

Please sign in to comment.