diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index a11705c7..0d5dde47 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -8,4 +8,5 @@ we encourage you to open an issue on the .. toctree:: Installing LSDB - Quickstart Guide \ No newline at end of file + Quickstart Guide + Contribution Guide diff --git a/docs/gettingstarted/contributing.rst b/docs/gettingstarted/contributing.rst new file mode 100644 index 00000000..01770c87 --- /dev/null +++ b/docs/gettingstarted/contributing.rst @@ -0,0 +1,38 @@ +Contribution Guide +================== + +Dev Guide - Getting Started +--------------------------- + +Before installing any dependencies or writing code, it's a great idea to create a +virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual +environments. If you have conda installed locally, you can run the following to +create and activate a new environment. + +.. code-block:: console + + >> conda create -n python=3.10 + >> conda activate + + +Once you have created a new environment, you can install this project for local +development using the following commands: + +.. code-block:: console + + >> pip install -e .'[dev]' + >> pre-commit install + >> conda install pandoc + + +Notes: + +1) The single quotes around ``'[dev]'`` may not be required for your operating system. +2) ``pre-commit install`` will initialize pre-commit for this local repository, so + that a set of tests will be run prior to completing a local commit. For more + information, see the Python Project Template documentation on + `pre-commit `_. +3) Installing ``pandoc`` allows you to verify that automatic rendering of Jupyter notebooks + into documentation for ReadTheDocs works as expected. For more information, see + the Python Project Template documentation on + `Sphinx and Python Notebooks `_. \ No newline at end of file diff --git a/docs/gettingstarted/installation.rst b/docs/gettingstarted/installation.rst index c9f52bcf..a4e4833f 100644 --- a/docs/gettingstarted/installation.rst +++ b/docs/gettingstarted/installation.rst @@ -41,7 +41,7 @@ To install the package and a minimum number of dependencies you can run: python -m pip install pytest # to validate package installation In alternative, you can execute the `setup_dev` script which installs all the additional requirements -to setup a development environment. Read more about contributing to LSDB in our :doc:`Quickstart Guide `. +to setup a development environment. Read more about contributing to LSDB in our :doc:`Contribution Guide `. .. code-block:: bash diff --git a/docs/index.rst b/docs/index.rst index c0c64d21..6e4db927 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,59 +2,24 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to lsdb's documentation! +LSDB - Large Survey DataBase ======================================================================================== -User Guide ----------- +LSDB is a framework that facilitates and enables fast spatial analysis for extremely large astronomical catalogs +(i.e. querying and crossmatching O(1B) sources). It aims to address large-scale data processing challenges, in +particular those brought up by `LSST `_. -You can install LSDB with `conda` or `pip`: +Built on top of Dask to efficiently scale and parallelize operations across multiple workers, it leverages +the `HiPSCat `_ data format for surveys in a partitioned HEALPix +(Hierarchical Equal Area isoLatitude Pixelization) structure. -.. code-block:: bash +In this website you will find: - >> # Conda installation - >> conda install -c conda-forge lsdb - >> # Pip installation - >> python3 -mpip install lsdb - -See `notebooks `_ for examples. - -Dev Guide - Getting Started ---------------------------- - -Before installing any dependencies or writing code, it's a great idea to create a -virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual -environments. If you have conda installed locally, you can run the following to -create and activate a new environment. - -.. code-block:: console - - >> conda create -n python=3.10 - >> conda activate - - -Once you have created a new environment, you can install this project for local -development using the following commands: - -.. code-block:: console - - >> pip install -e .'[dev]' - >> pre-commit install - >> conda install pandoc - - -Notes: - -1) The single quotes around ``'[dev]'`` may not be required for your operating system. -2) ``pre-commit install`` will initialize pre-commit for this local repository, so - that a set of tests will be run prior to completing a local commit. For more - information, see the Python Project Template documentation on - `pre-commit `_. -3) Installing ``pandoc`` allows you to verify that automatic rendering of Jupyter notebooks - into documentation for ReadTheDocs works as expected. For more information, see - the Python Project Template documentation on - `Sphinx and Python Notebooks `_. +- :doc:`Getting Started ` guides on how to install and run an example workflow +- :doc:`Tutorials `, and :doc:`Notebooks ` with more advanced usage examples +- The detailed :doc:`API Reference ` documentation +Learn more about contributing to this repository in our :doc:`Contribution Guide `. .. toctree:: :hidden: