Welcome to the local_volume_database documentation!
===================================

**local_volume_database** is a Python library of the fundamental properties of dwarf galaxies and star clusters in the Local Volume. 

Some useful links:

* `Link to GitHub repository <https://github.com/apace7/local_volume_database>`_
* `ADS Link to Overview paper  <https://ui.adsabs.harvard.edu/abs/2025OJAp....8E.142P/abstract>`_

.. The primary database catalogs are located as attachments in the: `Release Pages <https://github.com/apace7/local_volume_database/releases>`_ and the catalog columns are described in :doc:`usage`. The catalogs are  included as both csv and  fits files.
.. There is also a pdf summary file of the LVDB content.
.. An example of a catalog table: `Dwarf all csv <https://github.com/apace7/local_volume_database/releases/download/v0.0.2/dwarf_all.csv>`_
.. The github has the latest csv files here: `Database Tables <https://github.com/apace7/local_volume_database/tree/main/data/>`_.
.. For reproducibility, it is recommended to use one of the tagged release versions for scientific analysis.

.. Check out the :doc:`usage` section for further information, including
.. how to install (:ref:`installation`) the project.


Contents
--------

.. toctree::
   :maxdepth: 1

   usage
   tutorials
   contributing
   catalogs

   .. table_description
   .. yaml_description
   .. api