Developer Install#

Important

The following commands will install landlab into your current environment. Although not necessary, we highly recommend you install landlab into its own virtual environment.

If you will be modifying code or contributing new code to landlab, you will first need to get landlab’s source code and then install landlab from that code.

Source Install#

landlab is actively being developed on GitHub, where the code is freely available. If you would like to modify or contribute code, you can either clone our repository

$ git clone git://github.com/landlab/landlab.git

or download the tarball (a zip file is available for Windows users):

$ curl -OL https://github.com/landlab/landlab/tarball/master

Once you have a copy of the source code, you can install it into your current Python environment,

$ cd landlab
$ conda install --file=requirements.txt
$ pip install -e .
$ cd landlab
$ pip install -e .

Developer Tools#

Once you start developing with landlab, there are a number of other packages you may find useful to install. These packages are used for, among other things, testing landlab, and ensuring your code complies with landlab’s development standards.

$ conda install --file requirements-dev.txt --file requirements-testing.txt
$ pip install -e ".[dev,testing]"