<commit_before>.. _install:

==================
Installing Landlab
==================

Dependencies
============

The Landlab has the following dependencies:
- Python 2.7
- Numpy 1.7 or greater
- Scipy 0.12 or greater

.. note::

  Although not supported, landlab can be used with Python 3.X by simply
  running `2to3 <http://docs.python.org/2/library/2to3.html>`_ on the source.


Installing Python
=================

On all platforms (Linux, Windows 7 or greater, and MacOS X), we recommend a
preassembled scientific python distribution, such as `Continuum IO's Anaconda
<https://store.continuum.io/cshop/anaconda/>`_ or `Enthought's Canopy
<https://www.enthought.com/products/canopy/>`_ (we prefer to use Canopy but
any of these should be fine). These collections already include compatible
(and in some cases accelerated) versions of all of landlab's dependencies.
Download and follow the appropriate instructions for your operating
system/distribution.

On Linux systems, you can also install Python and the landlab dependencies
from your package manager.

Landlab uses `setuptools <https://pypi.python.org/pypi/setuptools>`_ for
packaging and is configured to automatically download and install the most
up-to-date version of its dependencies from `PyPI
<https://pypi.python.org/pypi>`_, if a satisfactory version is not already
installed.


Install Landlab
===============

There are several ways to install Landlab. Which method you use will 
depend on how you want to use landlab.
- If you want to use Landlab as-is, and not see or make changes to the
  code, you should follow the :ref:`Installing with pip <basic-install>`
  instructions.
- If you would like to see the Landlab source code and/or make changes or
  add to the code, you should follow :ref:`Install as a Developer
  <developer-install>` instructions.

.. _basic-install:

Installing with pip
-------------------

.. note::

  If you are developing landlab you will probably not want to do this!
  If you do, you would have to run this command everytime you make a change to
  the code. Instead, you want to install landlab in "development mode". See
  the :ref:`Install as a Developer <developer-install>` section for details
  on how to do this.

Use this method if you would like to install the landlab onto your machine
so you can use it as-is. You will be able to import landlab from the Python
command line, and write scripts that use landlab modules but will not have
access to the source. If you would would like to see the code or make tweaks
to it (large or small) you should install landlab from source (see
:ref:`Installing from source <source-install>`, or the
:ref:`Developer's Guide <developer-install>`).

The most recent stable release of Landlab is available at the `Python Package
Index <https://pypi.python.org/pypi>`_ and can be installed by running::

    pip install TheLandlab

This will install Landlab as well as any prerequisite packages. To upgrade
an existing Landlab installation::

    pip install TheLandlab --upgrade


.. _source-install:

Installing from source
----------------------

From Git
>>>>>>>>
<commit_msg>Changed links to developers guide to dev_guide.<commit_after>.. _install:

==================
Installing Landlab
==================

Dependencies
============

The Landlab has the following dependencies:
- Python 2.7
- Numpy 1.7 or greater
- Scipy 0.12 or greater

.. note::

  Although not supported, landlab can be used with Python 3.X by simply
  running `2to3 <http://docs.python.org/2/library/2to3.html>`_ on the source.


Installing Python
=================

On all platforms (Linux, Windows 7 or greater, and MacOS X), we recommend a
preassembled scientific python distribution, such as `Continuum IO's Anaconda
<https://store.continuum.io/cshop/anaconda/>`_ or `Enthought's Canopy
<https://www.enthought.com/products/canopy/>`_ (we prefer to use Canopy but
any of these should be fine). These collections already include compatible
(and in some cases accelerated) versions of all of landlab's dependencies.
Download and follow the appropriate instructions for your operating
system/distribution.

On Linux systems, you can also install Python and the landlab dependencies
from your package manager.

Landlab uses `setuptools <https://pypi.python.org/pypi/setuptools>`_ for
packaging and is configured to automatically download and install the most
up-to-date version of its dependencies from `PyPI
<https://pypi.python.org/pypi>`_, if a satisfactory version is not already
installed.


Install Landlab
===============

There are several ways to install Landlab. Which method you use will 
depend on how you want to use landlab.
- If you want to use Landlab as-is, and not see or make changes to the
  code, you should follow the :ref:`Installing with pip <basic-install>`
  instructions.
- If you would like to see the Landlab source code and/or make changes or
  add to the code, you should follow :ref:`The Developer's Guide
  <dev_guide>`.

.. _basic-install:

Installing with pip
-------------------

.. note::

  If you are developing landlab you will probably not want to do this!
  If you do, you would have to run this command everytime you make a change to
  the code. Instead, you want to install landlab in "development mode". See
  the :ref:`The Developer's Guide <dev_guide>` section for details
  on how to do this.

Use this method if you would like to install the landlab onto your machine
so you can use it as-is. You will be able to import landlab from the Python
command line, and write scripts that use landlab modules but will not have
access to the source. If you would would like to see the code or make tweaks
to it (large or small) you should install landlab from source (see
:ref:`Installing from source <source-install>`, or the
:ref:`Developer's Guide <dev_guide>`).

The most recent stable release of Landlab is available at the `Python Package
Index <https://pypi.python.org/pypi>`_ and can be installed by running::

    pip install TheLandlab

This will install Landlab as well as any prerequisite packages. To upgrade
an existing Landlab installation::

    pip install TheLandlab --upgrade


.. _source-install:

Installing from source
----------------------

From Git
>>>>>>>>

{'fraction_non_alphanumeric': 0.10376301040832667, 'fraction_numerical': 0.0044835868694955965, 'mean_word_length': 3.9968, 'pattern_counts': {'":': 0, '<': 25, '<?xml version=': 0, '>': 41, 'https://': 10, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '606230', 'n_tokens_mistral': 1748, 'n_tokens_neox': 1631, 'n_words': 843}