{"id":21822527,"url":"https://github.com/fastscape-lem/fastscape-demo","last_synced_at":"2025-04-14T03:52:32.591Z","repository":{"id":38407860,"uuid":"138616327","full_name":"fastscape-lem/fastscape-demo","owner":"fastscape-lem","description":"A collection of Jupyter notebooks as examples of usage of the Fastscape software stack.","archived":false,"fork":false,"pushed_at":"2023-09-27T08:47:14.000Z","size":7415,"stargazers_count":10,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T17:51:53.158Z","etag":null,"topics":["fastscape","jupyter","notebook"],"latest_commit_sha":null,"homepage":"https://fastscape.org/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fastscape-lem.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-25T15:46:57.000Z","updated_at":"2025-03-24T00:51:23.000Z","dependencies_parsed_at":"2022-09-06T07:00:55.346Z","dependency_job_id":null,"html_url":"https://github.com/fastscape-lem/fastscape-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Ffastscape-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Ffastscape-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Ffastscape-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Ffastscape-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fastscape-lem","download_url":"https://codeload.github.com/fastscape-lem/fastscape-demo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248819357,"owners_count":21166474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastscape","jupyter","notebook"],"created_at":"2024-11-27T17:15:52.541Z","updated_at":"2025-04-14T03:52:32.573Z","avatar_url":"https://github.com/fastscape-lem.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fastscape-lem/fastscape-demo/master?urlpath=lab)\n[![Test notebooks](https://github.com/fastscape-lem/fastscape-demo/workflows/Test%20notebooks/badge.svg)](https://github.com/fastscape-lem/fastscape-demo/actions)\n\n# FastScape Demo\n\nThis repository contains a collection of [Jupyter](http://jupyter.org/)\nnotebooks with examples of using the Fastscape software stack for landscape\nevolution modeling and topographic analysis.\n\nMore information on this website: https://fastscape.org\n\n- [How to run the notebooks?](#how-to-run-the-notebooks)\n    - [Run in the cloud (Binder)](#run-in-the-cloud-binder)\n    - [Install and run locally (Docker)](#install-and-run-locally-docker)\n    - [Install and run locally (Conda)](#install-and-run-locally-conda)\n- [How to contribute?](#how-to-contribute)\n\n## How to run the notebooks?\n\n### Run in the cloud (Binder)\n\nYou can run the notebooks in your browser without installing anything thanks to\n[binder](https://mybinder.org/). Just follow the link below or click on the\n\"launch binder\" badge above and it will launch remotely a new notebook server\nfor you:\n\n- [Run on binder](https://mybinder.org/v2/gh/fastscape-lem/fastscape-demo/master?urlpath=lab)\n\nThis service is for demo purpose only, do not rely on it for doing more serious\nwork.\n\n### Install and run locally (Docker)\n\n[Docker](https://www.docker.com/) images are built automatically for this\nrepository. Those images provide the whole computing environment, pre-installed\nand pre-configured for running the notebooks. The only requirement is to\nhave Docker installed on your machine. It is available on all platforms\nLinux/Windows/Mac and it can be installed from the Docker website or using one\nof your platform's package managers.\n\nRun the command below to first pull the latest image:\n\n```bash\n$ docker pull fastscape/fastscape-demo:latest\n```\n\nThen run the command below to start the Jupyterlab application from the Docker\ncontainer (replace `test-fastscape` by any other name you want to give to your\nlocal container):\n\n```bash\n$ docker run -it --name test-fastscape -p 8888:8888 fastscape/fastscape-demo jupyter lab --ip 0.0.0.0\n```\n\nYou can then enter in your browser the url and token provided to start using the\napplication.\n\nCheck [Docker's documentation](https://docs.docker.com/) for additional run\noptions, e.g., if you want to use the Jupyterlab application with notebooks or\nfiles on your local filesystem (i.e., not in the container).\n\nWhen you are done you need to stop (and optionally remove) the container:\n\n``` bash\n$ docker stop test-fastscape\n$ docker rm test-fastscape\n```\n\n### Install and run locally (Conda)\n\nAssuming that you have `git` and [conda](https://conda.io/docs/index.html)\ninstalled, you can install all the packages required to run the notebooks in a\nnew conda environment using the following commands:\n\n```bash\n$ git clone https://github.com/fastscape-lem/fastscape-demo\n$ cd fastscape-demo\n$ conda env create -f environment.yml\n$ conda activate fastscape-demo\n```\n\nThen run the command below to start the Jupyterlab application. It should\nopen a new tab in your browser.\n\n```bash\n$ jupyter lab\n```\n\n## How to contribute?\n\nYour contribution is welcome! Your can do so by reporting issues, suggesting new\nnotebook examples or improvements to the current examples.\n\nA few extra steps are required to prepare your contributions. You can first\nupdate the conda environment using the following command:\n\n```bash\n$ conda env update -n fastscape-demo --file environment-dev.yml \n```\n\nThis installs a few additional packages like\n[pre-commit](https://pre-commit.com/), which is used to ensure that all notebook\ncell outputs are cleared before adding or updating notebooks in this git\nrepository. Run the command below to enable pre-commit (you only need to do this\nonce):\n\n```bash\n$ pre-commit install\n```\n\nThe script below is useful if you want to ensure that all notebooks are running\nwithout error:\n\n```bash\n$ python execute_all_notebooks.py\n```\n\nThis script (as well as a script to build the Docker image) is run each time you\nopen or update a pull-request on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastscape-lem%2Ffastscape-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffastscape-lem%2Ffastscape-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastscape-lem%2Ffastscape-demo/lists"}