From 251d652a5e4c0b14c948ac9a6c0c26eaab350304 Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Tue, 13 Feb 2024 15:47:05 -0800 Subject: [PATCH 1/7] directory structure --- docs/Tutorials.rst | 12 +++++++++++ docs/gettingstarted.rst | 11 ++++++++++ docs/gettingstarted/installation.rst | 1 + docs/gettingstarted/quickstart.ipynb.ipynb | 20 +++++++++++++++++++ docs/tutorials/exporting_results.ipynb | 18 +++++++++++++++++ docs/tutorials/loading_data.ipynb | 18 +++++++++++++++++ docs/tutorials/margins.ipynb | 18 +++++++++++++++++ .../working_with_large_catalogs.ipynb | 18 +++++++++++++++++ 8 files changed, 116 insertions(+) create mode 100644 docs/Tutorials.rst create mode 100644 docs/gettingstarted.rst create mode 100644 docs/gettingstarted/installation.rst create mode 100644 docs/gettingstarted/quickstart.ipynb.ipynb create mode 100644 docs/tutorials/exporting_results.ipynb create mode 100644 docs/tutorials/loading_data.ipynb create mode 100644 docs/tutorials/margins.ipynb create mode 100644 docs/tutorials/working_with_large_catalogs.ipynb diff --git a/docs/Tutorials.rst b/docs/Tutorials.rst new file mode 100644 index 00000000..96c3721d --- /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/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..7396c52b --- /dev/null +++ b/docs/gettingstarted/installation.rst @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/docs/gettingstarted/quickstart.ipynb.ipynb b/docs/gettingstarted/quickstart.ipynb.ipynb new file mode 100644 index 00000000..4a225a0d --- /dev/null +++ b/docs/gettingstarted/quickstart.ipynb.ipynb @@ -0,0 +1,20 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "TBD " + ] + } + ], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/docs/tutorials/exporting_results.ipynb b/docs/tutorials/exporting_results.ipynb new file mode 100644 index 00000000..709d82cf --- /dev/null +++ b/docs/tutorials/exporting_results.ipynb @@ -0,0 +1,18 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "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..709d82cf --- /dev/null +++ b/docs/tutorials/loading_data.ipynb @@ -0,0 +1,18 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "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..709d82cf --- /dev/null +++ b/docs/tutorials/margins.ipynb @@ -0,0 +1,18 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "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..709d82cf --- /dev/null +++ b/docs/tutorials/working_with_large_catalogs.ipynb @@ -0,0 +1,18 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} From 76793b32521bd31eb768d5cd74e9fda1a1205ddc Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Thu, 15 Feb 2024 13:49:07 -0800 Subject: [PATCH 2/7] small fixes --- docs/gettingstarted/installation.rst | 3 +++ .../{quickstart.ipynb.ipynb => quickstart.ipynb} | 0 docs/tutorials/working_with_large_catalogs.ipynb | 4 +++- 3 files changed, 6 insertions(+), 1 deletion(-) rename docs/gettingstarted/{quickstart.ipynb.ipynb => quickstart.ipynb} (100%) diff --git a/docs/gettingstarted/installation.rst b/docs/gettingstarted/installation.rst index 7396c52b..9bddf72c 100644 --- a/docs/gettingstarted/installation.rst +++ b/docs/gettingstarted/installation.rst @@ -1 +1,4 @@ +Installation +============ + TBD \ No newline at end of file diff --git a/docs/gettingstarted/quickstart.ipynb.ipynb b/docs/gettingstarted/quickstart.ipynb similarity index 100% rename from docs/gettingstarted/quickstart.ipynb.ipynb rename to docs/gettingstarted/quickstart.ipynb diff --git a/docs/tutorials/working_with_large_catalogs.ipynb b/docs/tutorials/working_with_large_catalogs.ipynb index 709d82cf..9eed0263 100644 --- a/docs/tutorials/working_with_large_catalogs.ipynb +++ b/docs/tutorials/working_with_large_catalogs.ipynb @@ -5,7 +5,9 @@ "execution_count": null, "metadata": {}, "outputs": [], - "source": [] + "source": [ + "# TBD" + ] } ], "metadata": { From 5bde08af577e00a6b98cfdf06ac7190c5be7fe81 Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Thu, 15 Feb 2024 13:58:16 -0800 Subject: [PATCH 3/7] quickstart, changing TBD to actual input --- docs/gettingstarted/quickstart.ipynb | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/gettingstarted/quickstart.ipynb b/docs/gettingstarted/quickstart.ipynb index 4a225a0d..8953fef9 100644 --- a/docs/gettingstarted/quickstart.ipynb +++ b/docs/gettingstarted/quickstart.ipynb @@ -1,12 +1,17 @@ { "cells": [ { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", "metadata": {}, - "outputs": [], "source": [ - "TBD " + "# 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. " ] } ], From 9348774fa06e7d8763637de8b8df67d72448a96c Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Thu, 15 Feb 2024 14:14:10 -0800 Subject: [PATCH 4/7] updated index to link other sections --- docs/index.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index df19da49..27607e84 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 + From f8c86fd3ea95ea5bf83d3889af9d8636797b95f7 Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Thu, 15 Feb 2024 14:25:13 -0800 Subject: [PATCH 5/7] capitalization of tutorials --- docs/{Tutorials.rst => tutorials.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{Tutorials.rst => tutorials.rst} (100%) diff --git a/docs/Tutorials.rst b/docs/tutorials.rst similarity index 100% rename from docs/Tutorials.rst rename to docs/tutorials.rst From 82c017c0f9dc775dd63cb947aa9e1d0fc22d1be4 Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Thu, 15 Feb 2024 14:49:44 -0800 Subject: [PATCH 6/7] title for each tutorial subsection --- docs/tutorials/exporting_results.ipynb | 11 ++++++++--- docs/tutorials/loading_data.ipynb | 11 ++++++++--- docs/tutorials/margins.ipynb | 11 ++++++++--- docs/tutorials/working_with_large_catalogs.ipynb | 11 +++++++---- 4 files changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/tutorials/exporting_results.ipynb b/docs/tutorials/exporting_results.ipynb index 709d82cf..7d1d5328 100644 --- a/docs/tutorials/exporting_results.ipynb +++ b/docs/tutorials/exporting_results.ipynb @@ -1,10 +1,15 @@ { "cells": [ { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Exporting results" + ] + }, + { + "cell_type": "markdown", "metadata": {}, - "outputs": [], "source": [] } ], diff --git a/docs/tutorials/loading_data.ipynb b/docs/tutorials/loading_data.ipynb index 709d82cf..827045cd 100644 --- a/docs/tutorials/loading_data.ipynb +++ b/docs/tutorials/loading_data.ipynb @@ -1,10 +1,15 @@ { "cells": [ { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Loading data" + ] + }, + { + "cell_type": "markdown", "metadata": {}, - "outputs": [], "source": [] } ], diff --git a/docs/tutorials/margins.ipynb b/docs/tutorials/margins.ipynb index 709d82cf..55a2a3ff 100644 --- a/docs/tutorials/margins.ipynb +++ b/docs/tutorials/margins.ipynb @@ -1,10 +1,15 @@ { "cells": [ { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Margins" + ] + }, + { + "cell_type": "markdown", "metadata": {}, - "outputs": [], "source": [] } ], diff --git a/docs/tutorials/working_with_large_catalogs.ipynb b/docs/tutorials/working_with_large_catalogs.ipynb index 9eed0263..2b120186 100644 --- a/docs/tutorials/working_with_large_catalogs.ipynb +++ b/docs/tutorials/working_with_large_catalogs.ipynb @@ -1,13 +1,16 @@ { "cells": [ { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", "metadata": {}, - "outputs": [], "source": [ - "# TBD" + "# Working with large catalogs" ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [] } ], "metadata": { From 24f43fe49e0ebb115c164c69d2e22d3d50f75a9b Mon Sep 17 00:00:00 2001 From: Neven Caplar Date: Thu, 15 Feb 2024 14:54:15 -0800 Subject: [PATCH 7/7] minor fix --- docs/tutorials.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 96c3721d..e065afd3 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -9,4 +9,4 @@ functionality. Loading data into LSDB Working with large catalogs Margins - Exporting results \ No newline at end of file + Exporting results \ No newline at end of file