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 a zip file:

curl -OL https://github.com/landlab/landlab/archive/refs/heads/master.zip

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

mamba

cd landlab
mamba install --file=requirements.in
pip install -e .

conda

cd landlab
conda install --file=requirements.in
pip install -e .

pip

cd landlab
pip install -e .

Developer Tools#

Once you start developing with Landlab, we recommend that you use nox to automate common tasks such as, for example, running the tests, building the docs, and finding lint.

pip install nox

The following list show how to use nox for some of the more common tasks:

Run the tests:
```
nox -s test
```
Run the tests on the notebooks:
```
nox -s test-notebooks
```
Build the docs:
```
nox -s build-docs
```
Run the linters:
```
nox -s lint
```
To get a complete list of the available targets:
```
nox -l
```