{"id":21822517,"url":"https://github.com/fastscape-lem/s2s-future-dragonstone","last_synced_at":"2026-05-21T07:05:57.443Z","repository":{"id":55122128,"uuid":"327556729","full_name":"fastscape-lem/s2s-future-dragonstone","owner":"fastscape-lem","description":"S2S-Future DragonStone training program materials (Jupyter notebooks)","archived":false,"fork":false,"pushed_at":"2021-01-08T13:29:39.000Z","size":311,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-26T07:42:02.638Z","etag":null,"topics":["fastscape","jupyter","landscape","modeling","s2s-future"],"latest_commit_sha":null,"homepage":"","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":"2021-01-07T08:59:51.000Z","updated_at":"2021-05-25T13:35:11.000Z","dependencies_parsed_at":"2022-08-14T12:40:30.670Z","dependency_job_id":null,"html_url":"https://github.com/fastscape-lem/s2s-future-dragonstone","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%2Fs2s-future-dragonstone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Fs2s-future-dragonstone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Fs2s-future-dragonstone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastscape-lem%2Fs2s-future-dragonstone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fastscape-lem","download_url":"https://codeload.github.com/fastscape-lem/s2s-future-dragonstone/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244787379,"owners_count":20510136,"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","landscape","modeling","s2s-future"],"created_at":"2024-11-27T17:15:43.234Z","updated_at":"2026-05-21T07:05:52.424Z","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/s2s-future-dragonstone/master?urlpath=lab)\n[![Test notebooks](https://github.com/fastscape-lem/s2s-future-dragonstone/workflows/Test%20notebooks/badge.svg)](https://github.com/fastscape-lem/s2s-future-dragonstone/actions)\n\n# S2S-Future DragonStone\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\nThese notebooks were developed by Jean Braun in the framework of the first\ntraining program (called DragonStone) of the S2S-Future ITN (Innovative\nTraining Network) in January 2021.\n\nMore information concerning FastScape 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/s2s-future-dragonstone/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 in a terminal to first pull the latest image (note: the\nDocker application must be running, you might need to launch it first):\n\n```bash\n$ docker pull fastscape/s2s-future-dragonstone:latest\n```\n\nThen run the command below to start the Jupyterlab application from the Docker\ncontainer. Replace `dragonstone` by any other name you want to give to your\nlocal container (optional). Also Replace `/path/to/local-notebook-folder` by the\nfull path to the directory on your machine where you want to create/copy, edit and\npermanently store notebooks for this training course.\n\n```bash\n$ docker run \\\n    -it \\\n    --name dragonstone \\\n    -p 8888:8888 \\\n    -v /path/to/local-notebook-folder:/home/jovyan/my-local-folder \\\n    fastscape/s2s-future-dragonstone \\\n    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\nJupyterlab application.\n\nYou may want to copy the `notebooks` folder in your local working folder mounted\nin the docker container as `my-local-folder`. Open a terminal in Jupyterlab and\nrun the following command:\n\n```bash\n$ cp -R notebooks my-local-folder/\n```\n\nWhen you are done you can stop and remove the container:\n\n``` bash\n$ docker stop dragonstone\n$ docker rm dragonstone\n```\n\n#### Troubleshooting\n\n*The url I entered in my browser doesn't point to Jupyterlab*\n\nYou may already have another application running on localhost using the port\n`8888`. Try another port when running the `docker run` command above, e.g.,\nusing `-p 8889:8888`. You also need to change the port in the entered url\naccordingly (e.g., `localhost:8889`).\n\n*The url I entered in my browser gives a page asking for a token*\n\nCopy and paste the token given in the url. If the token is invalid, you may have\nanother Jupyterlab application already running on your machine. Try using\nanother port as described above.\n\nCheck [Docker's documentation](https://docs.docker.com/) for additional command\nline help and options.\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/s2s-future-dragonstone\n$ cd s2s-future-dragonstone\n$ conda env create -f environment.yml\n$ conda activate s2s-future-dragonstone\n```\n\nYou also need to install a few Jupyterlab extensions with the following command\n(this step won't be required anymore with Jupyterlab \u003e= 3.x):\n\n```bash\n$ jupyter labextension install \\\n    @jupyter-widgets/jupyterlab-manager \\\n    @pyviz/jupyterlab_pyviz \\\n    dask-labextension \\\n    ipygany\n```\n\nFinally 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 s2s-future-dragonstone --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%2Fs2s-future-dragonstone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffastscape-lem%2Fs2s-future-dragonstone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastscape-lem%2Fs2s-future-dragonstone/lists"}