diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst new file mode 100644 index 00000000..a11705c7 --- /dev/null +++ b/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 `_. + +.. toctree:: + + Installing LSDB + Quickstart Guide \ No newline at end of file diff --git a/docs/gettingstarted/installation.rst b/docs/gettingstarted/installation.rst new file mode 100644 index 00000000..9bddf72c --- /dev/null +++ b/docs/gettingstarted/installation.rst @@ -0,0 +1,4 @@ +Installation +============ + +TBD \ No newline at end of file diff --git a/docs/gettingstarted/quickstart.ipynb b/docs/gettingstarted/quickstart.ipynb new file mode 100644 index 00000000..8953fef9 --- /dev/null +++ b/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 +} diff --git a/docs/index.rst b/docs/index.rst index 589a6824..e7fa5640 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,5 +60,8 @@ Notes: :hidden: Home page - API Reference + Getting Started + Tutorials Notebooks + API Reference + diff --git a/docs/tutorials.rst b/docs/tutorials.rst new file mode 100644 index 00000000..e065afd3 --- /dev/null +++ b/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 + Working with large catalogs + Margins + Exporting results \ No newline at end of file diff --git a/docs/tutorials/exporting_results.ipynb b/docs/tutorials/exporting_results.ipynb new file mode 100644 index 00000000..7d1d5328 --- /dev/null +++ b/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 +} diff --git a/docs/tutorials/loading_data.ipynb b/docs/tutorials/loading_data.ipynb new file mode 100644 index 00000000..827045cd --- /dev/null +++ b/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 +} diff --git a/docs/tutorials/margins.ipynb b/docs/tutorials/margins.ipynb new file mode 100644 index 00000000..55a2a3ff --- /dev/null +++ b/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 +} diff --git a/docs/tutorials/working_with_large_catalogs.ipynb b/docs/tutorials/working_with_large_catalogs.ipynb new file mode 100644 index 00000000..2b120186 --- /dev/null +++ b/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 +}