Skip to content

Commit

Permalink
Expand the install guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
dopplershift committed May 12, 2015
1 parent 8c71b33 commit 9f76a1d
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 12 deletions.
11 changes: 0 additions & 11 deletions docs/source/RequirementsForInstall.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Welcome to MetPy's documentation!
=================================

Contents:
Requirements For Installation

.. toctree::
:maxdepth: 2

installguide
units
api/index
examples/index
Expand Down
51 changes: 51 additions & 0 deletions docs/source/installguide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
==================
Installation Guide
==================

------------
Requirements
------------
MetPy supports Python 2.7 as well as Python >= 3.2. Python 3.4 is the recommended version.

MetPy requires the following packages:
- NumPy >= 1.8.0
- SciPy >= 0.13.3
- Matplotlib >= 1.4.0
- pint >= 0.6

Installation Instructions for NumPy and SciPy can be found at:
http://www.scipy.org/scipylib/download.html

Installation Instructions for Matplotlib can be found at:
http://matplotlib.org/downloads.html

Pint is a pure python package and can be installed via ``pip install pint``.

------------
Installation
------------

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

.. parsed-literal::
pip install metpy
The source code can also be grabbed from `GitHub <http://github.com/MetPy/metpy>`_. From
the base of the source directory, run:

.. parsed-literal::
python setup.py install
This will build and install MetPy into your current Python installation.

--------
Examples
--------

The MetPy source comes with a set of example IPython notebooks in the ``examples/notebooks`` directory.
These can also be converted to standalone scripts (provided IPython is installed) using:

.. parsed-literal::
python setup.py examples
These examples are also seen within the documentation in the :ref:`examples-index`.

0 comments on commit 9f76a1d

Please sign in to comment.