Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a getting started page #382

Merged
merged 2 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Getting Started with HATS
=========================

Installation
------------

The latest release version of HATS is available to install with `pip <https://pypi.org/project/hats/>`_ (with conda coming soon).

.. code-block:: bash

python -m pip install hats

.. hint::

We recommend using a virtual environment. Before installing the package, create and activate a fresh
environment. Here are some examples with different tools:

.. tab-set::

.. tab-item:: venv

.. code-block:: bash

python -m venv ./hats_env
source ./hats_env/bin/activate

.. tab-item:: pyenv

With the pyenv-virtualenv plug-in:

.. code-block:: bash

pyenv virtualenv 3.11 hats_env
pyenv local hats_env

We recommend Python versions **>=3.9, <=3.12**.

HATS can also be installed from source on `GitHub <https://github.com/astronomy-commons/hats>`_.


LSDB
----

For the most part, we recommend accessing and processing HATS data using the `LSDB package
<https://github.com/astronomy-commons/lsdb>`_ framework. LSDB provides a variety of utility
functions as well as a lazy, distributed execution framework using Dask.

For detail on LSDB, see the `readthedocs site <https://docs.lsdb.io/en/stable/>`_.
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ operations on top of these utilities. Some known extensions:
:maxdepth: 1
:caption: Overview

getting_started
guide/directory_scheme
Notebooks <notebooks>

Expand All @@ -38,6 +39,14 @@ operations on top of these utilities. Some known extensions:
Pixel math <guide/pixel_math>
API Reference <autoapi/index>

Getting Started
-------------------------------------------------------------------------------

For the most part, we recommend accessing and processing HATS data using the `LSDB package
<https://github.com/astronomy-commons/lsdb>`_ framework. LSDB provides a variety of utility
functions as well as a lazy, distributed execution framework using Dask. However if you are are
interested in using just the HATS package, you can find installation instructions at the :ref:`getting started page<getting_started>`

Acknowledgements
-------------------------------------------------------------------------------

Expand Down