landlab

Installation Instructions

If you want to use Landlab to explore Earth surface dynamics, this is almost certainly the correct place to get install instruction. If you want to change the Landlab source code go to the developer install instructions.

In order to run Landlab you will need a python distribution. We recommend the Anaconda distribution (version 3.6 or higher).

You can install Landlab using either the pip or conda package management tools. We distribute Landlab through PyPI and conda-forge.

The following instructions will just install Landlab and its dependencies. There may be some additional dependencies necessary to run the Landlab notebooks or develop a model with Landlab (e.g., spyder). Below we also provide instructions to install a conda environment which includes everything you need to run the notebooks.

Conda instructions

Installation

In a terminal type:

$ conda install landlab -c conda-forge

If you work with many different packages that require conflicting dependencies, consider reading about (and using) conda environments.

Updating

In a terminal type:

$ conda update landlab

Uninstall

In a terminal type:

$ conda uninstall landlab

Pip Instructions

Installation

In a terminal type:

$ pip install landlab

Updating

In a terminal type:

$ pip install --upgrade landlab

Uninstall

In a terminal type:

$ pip uninstall landlab

Conda Environment

We have specified a conda environment which will install Landlab and everything else you need to run the Landlab Notebooks. First get a compressed copy of the latest release here, or you can clone the github repo.

Next you will need to have conda installed on your machine. In a terminal window/command prompt, navigate to the Landlab directory. Then create the environment with the following command.

$ conda env create --file=environment.yml

This will create a Landlab environment called landlab_notebooks. Activate that environment so that you will be using that version of python and all of the dependencies you just installed.

$ conda activate landlab_notebooks

You will need to activate this environment every time you want to use it. See tutorials for more about Landlab Notebooks.