Merge pull request #162 from astronomy-commons/tickets/LSDB-110

Added basic tutorial outline

docs/gettingstarted.rst

@@ -0,0 +1,11 @@
+Getting Started
+========================================================================================
+
+These pages will help you install and learn the basics of using LSDB. If you encounter any issues
+we encourage you to open an issue on the 
+`LSDB github repository <https://github.com/astronomy-commons/lsdb/issues>`_.
+
+.. toctree::
+
+    Installing LSDB <gettingstarted/installation>
+    Quickstart Guide <gettingstarted/quickstart>

docs/gettingstarted/installation.rst

@@ -0,0 +1,4 @@
+Installation
+============
+
+TBD 

docs/gettingstarted/quickstart.ipynb

@@ -0,0 +1,25 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Quickstart"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "LSDB provides a scalable framework for analyzing and cross-matching large astronomical catalogs. This tutorial section is under construction. "
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/index.rst

@@ -60,5 +60,8 @@ Notes:
    :hidden:
 
    Home page <self>
-   API Reference <autoapi/index>
+   Getting Started <gettingstarted>
+   Tutorials <tutorials>
    Notebooks <notebooks>
+   API Reference <autoapi/index>
+

docs/tutorials.rst

@@ -0,0 +1,12 @@
+Tutorials
+========================================================================================
+
+These pages contain a set of tutorial notebooks for working through core and more advanced LSDB
+functionality.
+
+.. toctree::
+
+    Loading data into LSDB <tutorials/loading_data>
+    Working with large catalogs <tutorials/working_with_large_catalogs>
+    Margins <tutorials/margins>
+    Exporting results <tutorials/exporting_results>

docs/tutorials/exporting_results.ipynb

@@ -0,0 +1,23 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Exporting results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/tutorials/loading_data.ipynb

@@ -0,0 +1,23 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Loading data"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/tutorials/margins.ipynb

@@ -0,0 +1,23 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Margins"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/tutorials/working_with_large_catalogs.ipynb

@@ -0,0 +1,23 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Working with large catalogs"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}