README.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "0",
   "metadata": {},
   "source": [
    "![Ivy logo](https://raw.githubusercontent.com/csdms/project/main/assets/CSDMS-logo-color-tagline-hor.png)\n",
    "\n",
    "<!-- Links -->\n",
    "\n",
    "[jhub]: https://csdms.colorado.edu/wiki/JupyterHub\n",
    "[badge]: https://img.shields.io/badge/Run%20on-EarthscapeHub-orange\n",
    "[jupyter]: ./lessons/jupyter/index.md\n",
    "[shell]: ./lessons/shell/index.md\n",
    "[editors]: ./lessons/editors/index.md\n",
    "[conda]: ./lessons/conda/index.md\n",
    "[python]: ./lessons/python/index.ipynb\n",
    "[git]: ./lessons/git/index.md\n",
    "[bmi]: ./lessons/bmi/index.ipynb\n",
    "[landlab]: ./lessons/landlab/landlab/00_welcome.ipynb\n",
    "[pymt]: ./lessons/pymt/index.ipynb\n",
    "[permamodel]: ./lessons/permamodel/index.ipynb\n",
    "[best-practices]: ./lessons/best-practices/index.md\n",
    "[hpc]: ./lessons/hpc/index.md\n",
    "[jhub-link]: https://explore.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fivy&urlpath=lab%2Ftree%2Fivy%2FREADME.ipynb%3Fautodecode&branch=main\n",
    "[jhub-info]: https://csdms.colorado.edu/wiki/JupyterHub\n",
    "[swc]: http://software-carpentry.org\n",
    "[swc-license]: https://github.com/swcarpentry/python-novice-inflammation/blob/gh-pages/LICENSE.md\n",
    "[coco]: https://github.com/CodeToCommunicate\n",
    "[coco-license]: https://github.com/CodeToCommunicate/CoCoLessons/blob/main/LICENSE\n",
    "[comses]: https://comses.net\n",
    "[comses-license]: https://github.com/comses-education/fair-osg-template/blob/main/LICENSE\n",
    "\n",
    "# CSDMS Ivy\n",
    "\n",
    "CSDMS Ivy is a collection of instructional materials on\n",
    "\n",
    "* modern, collaborative, scientific software development, and\n",
    "* use of community cyberinfrastructure tools\n",
    "\n",
    "for researchers in earth and planetary surface processes.\n",
    "\n",
    "CSDMS Ivy is\n",
    "written and maintained by the\n",
    "[Community Surface Dynamics Modeling System ](https://csdms.colorado.edu)(CSDMS).\n",
    "\n",
    "## Lessons\n",
    "\n",
    "CSDMS Ivy lessons are modular and independent,\n",
    "although the ordering below represents a typical progression.\n",
    "\n",
    "1. [Project Jupyter][jupyter]\n",
    "1. [Introduction to the Shell][shell]\n",
    "1. [Text Editors and Development Environments][editors]\n",
    "1. [Python Fundamentals][python]\n",
    "1. [Anaconda and conda][conda]\n",
    "1. [Version Control with git and GitHub][git]\n",
    "1. [Python for Modeling][python]\n",
    "1. [Landlab][landlab]\n",
    "1. [The Basic Model Interface (BMI)][bmi]\n",
    "1. [The Python Modeling Toolkit (pymt)][pymt]\n",
    "1. [Permamodel Toolkit][permamodel]\n",
    "1. [Introduction to Cluster Computing][hpc]\n",
    "1. [Best Practices in Scientific Software Development][best-practices]\n",
    "\n",
    "The lessons can be run locally\n",
    "if a user installs Anaconda and a `git` client on their computer.\n",
    "All lessons are also available to run\n",
    "on [EarthscapeHub][jhub].\n",
    "Click this button:\n",
    "\n",
    "[![Run on EarthscapeHub][badge]][jhub-link]\n",
    "\n",
    "to open the lessons directly on the EarthscapeHub *explore* instance!\n",
    "\n",
    "> **Note:** The EarthscapeHub *explore* instance is password-protected.\n",
    "  Please contact your instructor about obtaining a login,\n",
    "  or visit [this][jhub-info] CSDMS wiki page for more information.\n",
    "\n",
    "## Contributing\n",
    "\n",
    "CSDMS Ivy is an open source project;\n",
    "[contributions](./CONTRIBUTING.md) that follow\n",
    "the [contributor code of conduct](./CODE-OF-CONDUCT.md) are welcomed\n",
    "and are [acknowledged](./AUTHORS.md).\n",
    "All CSDMS Ivy course material is\n",
    "released under [CC BY 4.0 and MIT licenses](./LICENSE.md).\n",
    "If you use the CSDMS Ivy course material,\n",
    "please [cite](./CITATION.cff) it.\n",
    "\n",
    "[![DOI](https://zenodo.org/badge/278206679.svg)](https://zenodo.org/badge/latestdoi/278206679)\n",
    "\n",
    "## Acknowledgments\n",
    "\n",
    "CSDMS Ivy grew from a National Science Foundation Cybertraining pilot program,\n",
    "*Cybertraining: Pilot: Collaborative Research:\n",
    "Cybertraining for Earth Surface Processes Modelers*\n",
    "(award numbers\n",
    "[1924259](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1924259) and\n",
    "[1924185](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1924185)).\n",
    "\n",
    "Portions of the CSDMS Ivy Python lessons are derived\n",
    "from material that is copyright\n",
    "[Software Carpentry][swc]\n",
    "and remixed under their [license][swc-license].\n",
    "The Project Jupyter lesson\n",
    "is taken from the [Code to Communicate][coco] project\n",
    "and modified under their [license][coco-license].\n",
    "Material in the FAIR software lesson is adapted,\n",
    "under [license][comses-license],\n",
    "from a [CoMSES Net][comses] project.\n",
    "\n",
    "CSDMS Ivy is supported with funding from the National Science Foundation."
   ]
  }
 ],
 "metadata": {
  "jupytext": {
   "cell_metadata_filter": "-all",
   "main_language": "python",
   "notebook_metadata_filter": "-all"
  },
  "kernelspec": {
   "display_name": "Ivy",
   "language": "python",
   "name": "ivy"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}