Welcome to AstroPT's documentation!
===================================

.. image:: /images/shoggoth_telescope_sticker_2.png
   :width: 300
   :alt: AstroPT logo
   :align: center

|ICML| |arXiv1| |arXiv2| |License|

.. |ICML| image:: https://img.shields.io/badge/AI4Science@ICML-2024---?logo=https%3A%2F%2Fneurips.cc%2Fstatic%2Fcore%2Fimg%2FNeurIPS-logo.svg&labelColor=68448B&color=b3b3b3
   :target: https://openreview.net/forum?id=aOLuuLxqav

.. |arXiv1| image:: https://img.shields.io/badge/arXiv-2405.14930---?logo=arXiv&labelColor=b31b1b&color=grey
   :target: https://arxiv.org/abs/2405.14930

.. |arXiv2| image:: https://img.shields.io/badge/arXiv-2503.15312---?logo=arXiv&labelColor=b31b1b&color=grey
   :target: https://arxiv.org/abs/2503.15312

.. |License| image:: https://img.shields.io/badge/License-AGPLv3-green.svg
   :target: https://www.gnu.org/licenses/agpl-3.0.html

AstroPT 🐙: a Large Observation (foundation) Model for astronomy 🔭
---------------------------------------------------------------------

Welcome to the documentation for AstroPT, a project for training astronomical large observation
models. This repository began its life as Andrej Karpathy's
`nanoGPT <https://github.com/karpathy/nanoGPT>`_, and has been altered to be usable
for astronomical observation data.

Check out the `UniverseTBD <https://universetbd.org/>`_ Discord for updates:
`https://discord.gg/MNEVegvfJq <https://discord.gg/MNEVegvfJq>`_

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   introduction
   installation
   quickstart
   walkthrough
   aion_tokeniser
   contributing
..
   model
   tutorials
   api
   examples
   papers