Skip to content

Commit

Permalink
DOC: update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jorisvandenbossche committed Nov 21, 2015
1 parent a304931 commit b11403e
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions doc/source/install.rst
@@ -1,15 +1,20 @@
Installation
============

The released version of GeoPandas is 0.1. To install the released
version, use ``pip install geopandas``.
To install the released version, you can use pip::

pip install geopandas

or you can install the conda package from the IOOS channel::

conda install -c ioos geopandas

You may install the latest development version by cloning the
`GitHub`_ repository and using the setup script::

git clone https://github.com/geopandas/geopandas.git
cd geopandas
python setup.py install
pip install .

It is also possible to install the latest development version
available on PyPI with `pip` by adding the ``--pre`` flag for pip 1.4
Expand All @@ -22,13 +27,18 @@ repository with::
Dependencies
------------

Supports Python versions 2.6, 2.7, and 3.2+.
GeoPandas supports Python versions 2.6, 2.7, and 3.3+. The required
dependencies are:

- `numpy`_
- `pandas`_ (version 0.13 or later)
- `shapely`_
- `fiona`_
- `six`_
- `pyproj`_

Further, optional dependencies are:

- `geopy`_ 0.99 (optional; for geocoding)
- `psycopg2`_ (optional; for PostGIS connection)

Expand All @@ -38,6 +48,10 @@ For plotting, these additional packages may be used:
- `descartes`_
- `pysal`_

Further, `rtree`_ is an optional dependency. ``rtree`` requires the C library
`libspatialindex`_. If using brew, you can install using
``brew install Spatialindex``.

Testing
-------

Expand All @@ -62,8 +76,11 @@ including pull requests, on `Travis CI`_.
.. _six: https://pythonhosted.org/six
.. _psycopg2: https://pypi.python.org/pypi/psycopg2
.. _pysal: http://pysal.org
.. _pyproj: https://github.com/jswhit/pyproj
.. _rtree: https://github.com/Toblerity/rtree
.. _libspatialindex: https://github.com/libspatialindex/libspatialindex
.. _Travis CI: https://travis-ci.org/geopandas/geopandas


.. toctree::
:maxdepth: 2

0 comments on commit b11403e

Please sign in to comment.