Updated foundations notebook

Author: hrhampapura

notebooks/osdf_foundations.ipynb

@@ -140,41 +140,20 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Use OSDF ans PelicanFS protocol to access data"
+    "## Use OSDF and PelicanFS protocol to access data"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Set up osdf url to use with PelicanFS\n",
+    "### Set up osdf url to use with PelicanFS - Move this to next notebook ?????\n",
     "- We should one of the two pelicanFS FSSpec protocols ('osdf' or 'pelican') instead of the https protocol.\n",
     "- We will use the 'osdf' protocol and modify the existing CESM2-LENS catalog\n",
     "- So, the urls will look like: osdf_discovery_url/namespace_prefix/aws-region/bucket_name/path to file or object\n",
     "- In this case, the urls will look like osdf:///aws-opendata/us-west-2/ncar-cesm2-lens + path to individual zarr stores"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Accessing data from a cache"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Specifying a cache"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Accessing data directly from an origin"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -186,123 +165,55 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "------------------------------------- Ignore below this line ------------------------------"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "as well $m = a * t / h$ text! Similarly, you have access to other $\\LaTeX$ equation [**functionality**](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Typesetting%20Equations.html) via MathJax (demo below from link),\n",
-    "\n",
-    "\\begin{align}\n",
-    "\\dot{x} & = \\sigma(y-x) \\\\\n",
-    "\\dot{y} & = \\rho x - y - xz \\\\\n",
-    "\\dot{z} & = -\\beta z + xy\n",
-    "\\end{align}"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Check out [**any number of helpful Markdown resources**](https://www.markdownguide.org/basic-syntax/) for further customizing your notebooks and the [**Jupyter docs**](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Working%20With%20Markdown%20Cells.html) for Jupyter-specific formatting information. Don't hesitate to ask questions if you have problems getting it to look *just right*."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Last Section\n",
-    "\n",
-    "If you're comfortable, and as we briefly used for our embedded logo up top, you can embed raw html into Jupyter Markdown cells (edit to see):"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "<div class=\"admonition alert alert-info\">\n",
-    "    <p class=\"admonition-title\" style=\"font-weight:bold\">Info</p>\n",
-    "    Your relevant information here!\n",
-    "</div>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Feel free to copy this around and edit or play around with yourself. Some other `admonitions` you can put in:"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "<div class=\"admonition alert alert-success\">\n",
-    "    <p class=\"admonition-title\" style=\"font-weight:bold\">Success</p>\n",
-    "    We got this done after all!\n",
-    "</div>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "<div class=\"admonition alert alert-warning\">\n",
-    "    <p class=\"admonition-title\" style=\"font-weight:bold\">Warning</p>\n",
-    "    Be careful!\n",
-    "</div>"
+    "#### Specifying a cache"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<div class=\"admonition alert alert-danger\">\n",
-    "    <p class=\"admonition-title\" style=\"font-weight:bold\">Danger</p>\n",
-    "    Scary stuff be here.\n",
-    "</div>"
+    "pelfs = PelicanFileSystem(\"pelican://osg-htc.org\", preferred_caches=[\"https://cache.example.com\"])"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We also suggest checking out Jupyter Book's [brief demonstration](https://jupyterbook.org/content/metadata.html#jupyter-cell-tags) on adding cell tags to your cells in Jupyter Notebook, Lab, or manually. Using these cell tags can allow you to [customize](https://jupyterbook.org/interactive/hiding.html) how your code content is displayed and even [demonstrate errors](https://jupyterbook.org/content/execute.html#dealing-with-code-that-raises-errors) without altogether crashing our loyal army of machines!"
+    "#### Accessing data directly from an origin"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "---"
+    "pelfs = PelicanFileSystem(\"pelican://osg-htc.org\", direct_reads=True)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "## Summary\n",
-    "Add one final `---` marking the end of your body of content, and then conclude with a brief single paragraph summarizing at a high level the key pieces that were learned and how they tied to your objectives. Look to reiterate what the most important takeaways were.\n",
+    "In this notebook, we gave a brief introduction to the Open Science Data Federation, the Pelican Platform and learnt how to access data using PelicanFS. In particular, we discussed how to use PelicanFS to\n",
+    "\n",
+    "- Access data without specifying a cache\n",
+    "- Access data from a specific cache\n",
+    "- Access data directly from the data origin\n",
+    "\n",
+    "all via the OSDF protocol.\n",
     "\n",
     "### What's next?\n",
-    "Let Jupyter book tie this to the next (sequential) piece of content that people could move on to down below and in the sidebar. However, if this page uniquely enables your reader to tackle other nonsequential concepts throughout this book, or even external content, link to it here!"
+    "In the next notebooks, we will learn how to access data from various climate datasets into our notebook using PelicanFS."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "## Resources and references\n",
-    "Finally, be rigorous in your citations and references as necessary. Give credit where credit is due. Also, feel free to link to relevant external material, further reading, documentation, etc. Then you're done! Give yourself a quick review, a high five, and send us a pull request. A few final notes:\n",
-    " - `Kernel > Restart Kernel and Run All Cells...` to confirm that your notebook will cleanly run from start to finish\n",
-    " - `Kernel > Restart Kernel and Clear All Outputs...` before committing your notebook, our machines will do the heavy lifting\n",
-    " - Take credit! Provide author contact information if you'd like; if so, consider adding information here at the bottom of your notebook\n",
-    " - Give credit! Attribute appropriate authorship for referenced code, information, images, etc.\n",
-    " - Only include what you're legally allowed: **no copyright infringement or plagiarism**\n",
-    " \n",
-    "Thank you for your contribution!"
+    "- [Open Science Data Federation](https://osg-htc.org/services/osdf.html)\n",
+    "- [Pelican Platform](https://pelicanplatform.org)\n",
+    "- [PelicanFS](https://github.com/PelicanPlatform/pelicanfs) "
    ]
   }
  ],