.. AstroHammer documentation master file, created by
   sphinx-quickstart on Tue Jun 22 05:34:34 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

AstroHammer: Astro Techniques for Beginners
========================================================================

|badge1| |badge2| |badge3|

.. |badge1| image:: https://readthedocs.org/projects/project-astro-hammer/badge/?version=latest
   :target: https://hipp.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |badge2| image:: https://img.shields.io/github/last-commit/ChenYangyao/project-astro-hammer
   :target: https://github.com/ChenYangyao/project-astro-hammer/commits/master
   :alt: Commits 

.. |badge3| image:: https://img.shields.io/github/license/ChenYangyao/project-astro-hammer
   :target: https://github.com/ChenYangyao/project-astro-hammer/blob/master/LICENSE
   :alt: License

About
---------

AstroHammer is a small project hosted by the galaxy group in the Department of 
Astronomy, Tsinghua University. Its main target is to provide
computer-science-related introduction material for astronomy beginners. 
The features of this project include:

- A large range of topic is covered, from organizing your first project, 
  first time working on a machine, managing your work environment, 
  programming, using famous and useful third-party libraries,
  writing language-specific libraries,
  publishing data/software, to developing interesting GUI-based softwares.
- The basic parts of those topics are presented, with emphasis on the 
  frequent usage in Astronomy-related situation. Carefully 
  chosen "Futher Reading" materials are provided as the starting-point 
  to master them.

To help readers quickly dive into those topics, the following resources 
are provided:

- This `Github <https://github.com/ChenYangyao/project-astro-hammer>`_ repository: all material (code samples, data samples, 
  lecture videos, problem sets and solutions) are hosted here.
- The lecture notes are served in `Read the Docs <https://project-astro-hammer.readthedocs.io/>`_.
- Regular online meetings will be organize to introduce these topics. 
  The meetings will loop over all the topics periodically (1~2 years per loop),
  everyone is welcomed. See below for a Schedule.

The project, currently, is organized by Kai Wang (`kosmoswalker.com <https://www.kosmoswalker.com/>`_) 
and Yangyao Chen (`chenyangyao.com <https://www.chenyangyao.com/>`_). We welcome everyone 
to contribute to this project. For example: 

- Raise a Github issus for any problem encountered when learning.
- Start a Pull Request to help improve the quality of the present material, or 
  add new topics you'd like to learn from us.
- Register as a reporter in the online meeting to share your ideas, tools 
  or anything that is technically interesting.


Lecture Notes
----------------------

The current prepared topics are listed below. We prepare to finish them in 
(at-least) 7 meetings.

.. toctree::
   :maxdepth: 1

   usage/project-management/index
   usage/development-environment/index
   usage/python-programming/index
   usage/cpp-programming/index
   usage/algorithms/index
   usage/parallel-computation/index
   usage/gui-development/index


.. Indices and tables
.. --------------------
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`