.. _install: ========================= 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 :ref:`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: .. code-block:: bash $ 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: .. code-block:: bash $ conda update landlab Uninstall ````````` In a terminal type: .. code-block:: bash $ conda uninstall landlab Pip Instructions ---------------- Installation ```````````` In a terminal type: .. code-block:: bash $ pip install landlab Updating ```````` In a terminal type: .. code-block:: bash $ pip install --upgrade landlab Uninstall ````````` In a terminal type: .. code-block:: bash $ pip uninstall landlab .. _conda_environment: 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. .. code-block:: bash $ 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. .. code-block:: bash $ conda activate landlab_notebooks You will need to activate this environment every time you want to use it. See :ref:`tutorials ` for more about Landlab Notebooks. Additional Resources -------------------- Over time the core Landlab development team has written resources for different issues related to installation. These are below. Note that some are very out of date. For example, one of them describes an installation of python 2.7. We do not recommend installing a python 2.x version. .. toctree:: :maxdepth: 2 installing_python rough_guide_to_python anaconda_install installing_grass correcting_paths troubleshooting