{"id":26183009,"url":"https://github.com/csdms/roadshow-diffusion","last_synced_at":"2025-07-31T21:02:32.061Z","repository":{"id":270767147,"uuid":"911396002","full_name":"csdms/roadshow-diffusion","owner":"csdms","description":"A diffusion model used for teaching in the CSDMS Roadshow","archived":false,"fork":false,"pushed_at":"2025-01-29T17:31:59.000Z","size":46,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-01-29T18:29:56.444Z","etag":null,"topics":["diffusion","modeling","python"],"latest_commit_sha":null,"homepage":"https://csdms.colorado.edu","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csdms.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-02T23:17:56.000Z","updated_at":"2025-01-29T17:31:59.000Z","dependencies_parsed_at":"2025-01-10T18:27:24.361Z","dependency_job_id":null,"html_url":"https://github.com/csdms/roadshow-diffusion","commit_stats":null,"previous_names":["csdms/roadshow-diffusion"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Froadshow-diffusion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Froadshow-diffusion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Froadshow-diffusion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Froadshow-diffusion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csdms","download_url":"https://codeload.github.com/csdms/roadshow-diffusion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243125690,"owners_count":20240274,"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":["diffusion","modeling","python"],"created_at":"2025-03-11T22:33:45.260Z","updated_at":"2025-03-11T22:33:45.910Z","avatar_url":"https://github.com/csdms.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# roadshow-diffusion\n\nA model used for teaching in the [CSDMS Roadshow](https://csdms.colorado.edu/wiki/Roadshows).\n\n## What is CSDMS and why are we here?\n\n[CSDMS](https://csdms.colorado.edu) is an international community of researchers studying surface processes, with an emphasis on modeling.\nModeling requires code.\nHistorically, scientists haven't been great at writing code that's maintainable and easily used by others.\nTherefore, a secondary emphasis at CSDMS is on helping scientists write [FAIR software](https://www.nature.com/articles/s41597-022-01710-x)--code that's findable, accessible, interoperable, and reusable.\nThat's why we're here.\nScience is first, but software is an engine that drives science.\nBetter software enhances scientific productivity.\n\n## What are we going to do?\n\nWe're going to develop a model.\nWe'll use a technique a lot of grad students we know use.\nAlong the way, we'll comment on best practices in geoscientific software development.\n\nTopics we'll encounter:\n\n* Shell commands\n* Modularization\n* Version control\n* Collaborative coding\n* Text editors\n* Virtual environments\n* Package management\n* Unit testing\n* Continuous integration\n* Documentation\n\nIf we have time, we'll show a more comprehensive workflow for developing a model.\n\nWe'll finish by working with [Landlab](https://landlab.csdms.io/), a toolkit for developing models.\nIt takes care of many of the tedious details that a scientist would have to deal with when developing a model.\n\n## How will this work?\n\nHere are the topics we'll cover in order to develop our model.\n\n* Project Jupyter\n    * JupyterHub: login to *explore* Hub\n    * JupyterLab: show components\n    * Notebook: open a new notebook and show basics\n* Shell (bash) commands\n* Diffusion model in a notebook I\n* Intro to Git/GitHub\n    * Set up SSH keys\n    * Set up a repo for the diffusion model notebook\n    * Clone repo to workspace on *explore* Hub\n* Export notebook to Python source\n* Text editors\n* Virtual environments\n    * conda\n    * venv or virtualenv\n* Refactor diffusion model\n    * Rename file to diffusion.py to adhere to module naming rules\n    * Modularize model script\n    * Demonstrate collaborative coding through GitHub PRs\n* Unit testing\n    * Test-driven development\n* Package model\n    * Module definition file\n    * Basic pyproject.toml file\n    * Show how to pip install into a venv\n* Documentation\n* Diffusion model in a notebook II\n    * Import diffusion model from new package\n    * Import someone else's diffusion model\n* Visualize model output with Jupyter widgets\n* Landlab\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Froadshow-diffusion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsdms%2Froadshow-diffusion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Froadshow-diffusion/lists"}