Landlab

An open source Python package for numerical modeling of Earth surface dynamics.
https://github.com/landlab/landlab

Last synced: about 9 hours ago
JSON representation

Repository metadata

Landlab codebase, wiki, and tests

• Host: GitHub
• URL: https://github.com/landlab/landlab
• Owner: landlab
• License: mit
• Created: 2014-05-09T04:52:50.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T23:00:14.000Z (about 20 hours ago)
• Last Synced: 2024-05-11T07:06:32.027Z (about 12 hours ago)
• Language: Jupyter Notebook
• Homepage: https://landlab.readthedocs.io/
• Size: 275 MB
• Stars: 331
• Watchers: 29
• Forks: 325
• Open Issues: 377
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.rst
  • Citation: CITATION.cff
  • Authors: AUTHORS.rst

README

        
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3776837.svg

   :target: https://doi.org/10.5281/zenodo.3776837

.. image:: https://readthedocs.org/projects/landlab/badge/?version=latest

    :target: https://landlab.readthedocs.org

.. image:: https://github.com/landlab/landlab/actions/workflows/test.yml/badge.svg

    :target: https://github.com/landlab/landlab/actions/workflows/test.yml

.. image:: https://github.com/landlab/landlab/actions/workflows/lint.yml/badge.svg

    :target: https://github.com/landlab/landlab/actions/workflows/lint.yml

.. image:: https://github.com/landlab/landlab/actions/workflows/test-notebooks.yml/badge.svg

    :target: https://github.com/landlab/landlab/actions/workflows/test-notebooks.yml

.. image:: https://github.com/landlab/landlab/actions/workflows/docs.yml/badge.svg

    :target: https://github.com/landlab/landlab/actions/workflows/docs.yml

.. image:: https://coveralls.io/repos/landlab/landlab/badge.png

    :target: https://coveralls.io/r/landlab/landlab

.. image:: https://mybinder.org/badge_logo.svg

 :target: https://mybinder.org/v2/gh/landlab/landlab/master?filepath=notebooks/welcome.ipynb

=======

Landlab

=======

What does Landlab do?

---------------------

.. start-intro

Landlab is an open-source Python-language package for numerical modeling of

Earth surface dynamics. It contains

* A gridding engine which represents the model domain. Regular and irregular

  grids are supported.

* A library of process components, each of which represents a physical process

  (e.g., generation of rain, erosion by flowing water). These components have

  a common interface and can be combined based on a user's needs.

* Utilities that support general numerical methods, file input/output, and

  visualization.

In addition Landlab contains a set of Jupyter notebook tutorials providing

an introduction to core concepts and examples of use.

Landlab was designed for disciplines that quantify Earth surface dynamics such

as geomorphology, hydrology, glaciology, and stratigraphy. It can also be used

in related fields. Scientists who use this type of model often build

their own unique model from the ground up, re-coding the basic building blocks

of their landscape model rather than taking advantage of codes that have

already been written. Landlab saves practitioners from the need for this kind

of re-invention by providing standardized components that they can re-use.

Watch the webinar `Landlab Toolkit Overview `_

at CSDMS to learn more.

.. end-intro

-----------

`Read the documentation on ReadTheDocs! `_

-----------

Installation

------------

To install the latest release of *landlab* using *pip*, simply run the following

in your terminal of choice:

.. code-block:: bash

  $ pip install landlab

For a full description of how to install *Landlab*, including using *mamba*/*conda*,

please see the documentation for our `installation instructions`_.

.. _installation instructions: https://landlab.readthedocs.io/en/master/installation.html

Source code

-----------

If you would like to modify or contribute code to *Landlab* or use the very latest

development version, please see the documentation that describes how to

`install landlab from source`_.

.. _install landlab from source: https://landlab.readthedocs.io/en/master/install/developer_install.html

Are there any examples of using Landlab I can look at?

------------------------------------------------------

The Landlab package contains a directory, ``landlab/notebooks``, with

Jupyter Notebooks describing core concepts and giving examples of using components.

The file ``landlab/notebooks/welcome.ipynb`` provides a table of contents to

the notebooks and is the recommended starting place.

Additionally, there are a set of notebooks curated to teach physical processes

located in the directory ``landlab/notebooks/teaching``.

Run on Binder

`````````````

To launch an instance of

Binder and `explore the notebooks click here`_.

.. _explore the notebooks click here: https://mybinder.org/v2/gh/landlab/landlab/master?filepath=notebooks/welcome.ipynb

To launch a Binder instance that goes straight to the `teaching notebooks click here`_.

.. _teaching notebooks click here: https://mybinder.org/v2/gh/landlab/landlab/master?filepath=notebooks/teaching/welcome_teaching.ipynb

Run on EarthscapeHub

````````````````````

The Landlab notebooks can also be run on `EarthscapeHub`_.

Visit this link to learn how to sign up for a free account.

Explore the example notebooks on the

`lab`__ or `jupyter`__ Hub instance.

Or, use the teaching notebooks on the

`lab`__ or `jupyter`__ Hub instance.

Be sure to run all notebooks with the *CSDMS* kernel.

.. _EarthscapeHub: https://csdms.colorado.edu/wiki/JupyterHub

.. __: https://lab.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Flandlab%2Flandlab&urlpath=lab%2Ftree%2Flandlab%2Fnotebooks%2Fwelcome.ipynb&branch=master

.. __: https://jupyter.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Flandlab%2Flandlab&urlpath=lab%2Ftree%2Flandlab%2Fnotebooks%2Fwelcome.ipynb&branch=master

.. __: https://lab.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Flandlab%2Flandlab&urlpath=lab%2Ftree%2Flandlab%2Fnotebooks%2Fteaching%2Fwelcome_teaching.ipynb&branch=master

.. __: https://jupyter.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Flandlab%2Flandlab&urlpath=lab%2Ftree%2Flandlab%2Fnotebooks%2Fteaching%2Fwelcome_teaching.ipynb&branch=master

License

-------

*landlab* is licensed under the MIT License.

Citing Landlab

--------------

If you use any portion of Landlab, please see the documentation for our

`citation guidelines`_.

.. _citation guidelines: https://landlab.readthedocs.io/en/master/citing.html

Contact

-------

.. start-contact

The recommended way to contact the Landlab team is with a

`GitHub Issue `_.

* **Bug reports**: Please make an Issue describing the bug so we can address it, or work

  with you to address it. Please try to provide a `minimal, reproducible example

  `_.

* **Documentation**: If something in our documentation is not clear to you, please make an

  issue describing the what isn't clear. Someone will tag

  the most appropriate member of the core Landlab team. We will work to clarify

  your question and revise the documentation so that it is clear for the next user.

Keep in touch with the latest *landlab* news by following us on `Twitter `_.

During workshops and clinics, we sometimes use the

`Landlab Slack channel `_.

.. end-contact

      

Citation (CITATION.cff)

# YAML 1.2
---
cff-version: "1.2.0"
message: "If you use this software, please cite it using these metadata."
abstract : "Landlab is an open-source Python-language package for numerical modeling of Earth surface dynamics."
type: software
authors:
  -
    family-names: Hutton
    given-names: Eric
    orcid: "https://orcid.org/0000-0002-5864-6459"
  -
    family-names: Barnhart
    given-names: Katy
    orcid: "https://orcid.org/0000-0001-5682-455X"
  -
    family-names: Hobley
    given-names: Dan
    orcid: "https://orcid.org/0000-0003-2371-0534"
  -
    family-names: Tucker
    given-names: Greg
    orcid: "https://orcid.org/0000-0003-0364-5800"
  -
    family-names: Nudurupati
    given-names: Sai
    orcid: "https://orcid.org/0000-0002-2090-7561"
  -
    family-names: Adams
    given-names: Jordan
    orcid: "https://orcid.org/0000-0003-0137-9879"
  -
    family-names: Gasparini
    given-names: Nicole
    orcid: "https://orcid.org/0000-0002-0803-3697"
  -
    family-names: Shobe
    given-names: Charlie
    orcid: "https://orcid.org/0000-0003-3015-1283"
  -
    family-names: Strauch
    given-names: Ronda
    orcid: "https://orcid.org/0000-0003-3093-8449"
  -
    family-names: Knuth
    given-names: Jenny
    orcid: "https://orcid.org/0000-0001-7066-7992"
  -
    family-names: Mouchene
    given-names: Margaux
    orcid: "https://orcid.org/0000-0002-8243-3517"
  -
    family-names: Lyons
    given-names: Nathan
    orcid: "https://orcid.org/0000-0001-6965-3374"
  -
    family-names: Litwin
    given-names: David
    orcid: "https://orcid.org/0000-0002-8097-4029"
  -
    family-names: Glade
    given-names: Rachel
    orcid: "https://orcid.org/0000-0002-0345-1953"
  -
    name: Giuseppecipolla95
  -
    family-names: Manaster
    given-names: Amanda
  -
    family-names: Abby
    given-names: Langston
  -
    family-names: Thyng
    given-names: Kristen
    orcid: "https://orcid.org/0000-0002-8746-614X"
  -
    family-names: Rengers
    given-names: Francis
    orcid: "https://orcid.org/0000-0002-1825-0943"
title: "landlab"
identifiers:
  -
    type: doi
    value: 10.5194/esurf-8-379-2020
    description: >-
      "Short communication: Landlab v2.0: A software package for
      Earth surface dynamics". Earth Surface Dynamics Discussions,
      May 2020, Volume 8, Issue 2
  -
    type: doi
    value: 10.5194/esurf-5-21-2017
    description: >-
      "Creative computing with Landlab: an open-source
       toolkit for building, coupling, and exploring
       two-dimensional numerical models of
       Earth-surface dynamics". Earth Surface Dynamics,
       January 2017, Volume 5, Issue 1
  -
    type: doi
    value: 10.5281/zenodo.3776837
    description: The versioned DOI for the version 2.0.1 of landlab.
  -
    type: doi
    value: 10.5281/zenodo.595872
    description: The concept DOI for the collection containing all versions of landlab.
repository-code: "https://github.com/landlab/landlab"
url: "https://landlab.readthedocs.io"
date-released: "2020-04-29"
keywords:
  - "bmi"
  - "component modeling"
  - "earth science"
  - "gridding engine"
  - "model coupling"
  - "numerical modeling"
license: MIT
doi: 10.5281/zenodo.595872
...

---

Owner metadata

• Name: Landlab
• Login: landlab
• Email:
• Kind: organization
• Description: a python toolkit for for modeling earth surface processes
• Website: http://landlab.github.io
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/7543483?v=4
• Repositories: 24
• Last ynced at: 2023-10-09T09:44:09.216Z
• Profile URL: https://github.com/landlab

---

GitHub Events

Total

• Create event: 1235
• Commit comment event: 8
• Release event: 12
• Delete event: 973
• Member event: 1
• Pull request event: 2055
• Fork event: 328
• Issues event: 1092
• Watch event: 335
• Issue comment event: 5785
• Push event: 5469
• Pull request review event: 545
• Pull request review comment event: 1149
• Gollum event: 1122

Last Year

• Create event: 257
• Delete event: 235
• Fork event: 28
• Issue comment event: 473
• Issues event: 80
• Pull request event: 505
• Pull request review comment event: 102
• Pull request review event: 116
• Push event: 722
• Watch event: 33

---

Committers metadata

Last synced: 2 days ago

Name	Email	Commits
Eric Hutton	m****n@g****m	3542
Katy Barnhart	k****t@u****v	1126
Dan Hobley	d****y@g****m	1025
Greg Tucker	g****r@c****u	854
Jordan Adams	j****5@t****u	262
Sai Nudurupati	s****u@u****u	257
Nicole M Gasparini	n****r@g****m	228
dependabot[bot]	4****]	118
Charlie Shobe	c****e@e****u	69
David Litwin	d****n@p****t	62
Ronda Strauch	r****h@u****u	49
Laurent Roberge	l****e@t****u	46
Jenny Knuth	i****o@g****m	44
Sebastien Lenard	s****d@g****m	43
Margaux Mouchene	m****e@l****t	40
Benjamin Campforts	b****s@g****m	36
pre-commit-ci[bot]	6****]	30
Berkan M	4****5	28
Nathan Lyons	n****s@g****m	27
Jeffrey Keck	k****e@g****m	18
Rachel Glade	r****e@g****m	12
Dylan Ward	d****d@u****u	11
Giuseppecipolla95	3****5	11
Mark Piper	m****r@c****u	6
Allison Pfeiffer	p****f@u****u	6
Shelby Ahrendt	3****t	2
Jay Hariharan	j****n@u****u	2
Amanda Manaster	a****e@u****u	2
Benjamin Campforts	b****a@b****n	2
root	r****t@0****a	1
and 8 more...

Committer domains:

• uw.edu: 4
• tulane.edu: 2
• colorado.edu: 2
• ksu.edu: 1
• att.net: 1
• benjamins-mbp.kpn: 1
• utexas.edu: 1
• uc.edu: 1
• laposte.net: 1
• posteo.net: 1
• email.wm.edu: 1
• usgs.gov: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/landlab/landlab

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • pypi: 4,729 last-month
• Total docker downloads: 141
• Total dependent packages: 10 (may contain duplicates)
• Total dependent repositories: 38 (may contain duplicates)
• Total versions: 112
• Total maintainers: 3

---

Dependencies

Score: 18.70190674072445