.. Taotie documentation master file, created by
   sphinx-quickstart on Sat Jul 13 14:53:02 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=============================================================================
Tao Tie (饕餮) - A curated collection of resources for astrophysical research
=============================================================================

    “The taotie is a motif commonly found on Chinese ritual bronze vessels from the Shang and Zhou 
    dynasty...In ancient Chinese mythology like "Classic of Mountains and Seas", the "taotie" (饕餮) 
    is one of the "four evil creatures of the world"...a greedy and gluttonous son of the Jinyun 
    clan, who lived during the time of the 
    legendary Yellow Emperor.” - `Wikipedia <https://en.wikipedia.org/wiki/Taotie>`_ 
    
    "缙云氏有不才子，贪于饮食，冒于货贿，天下谓之饕餮" 
    - `《吕氏春秋·先识》 <https://zh.wikipedia.org/wiki/%E9%A5%95%E9%A4%AE>`_

.. image:: images/taotie_logo.png
   :width: 600
   :alt: Taotie logo

.. image:: https://readthedocs.org/projects/taotie/badge/?version=latest
   :target: https://taotie.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. image:: https://img.shields.io/badge/repo-GitHub-3D76C2.svg
   :target: https://github.com/dr-guangtou/taotie 
   :alt: Repo on GitHub
.. image:: https://img.shields.io/badge/repo-GitLab-6C488A.svg
   :target: https://gitlab.com/dr-guangtou/taotie 
   :alt: Repo on GitLab
.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg 
   :alt: Awesome List

Starting Your Career as a Researcher
------------------------------------

.. toctree::
   :maxdepth: 1

   resource/research/getting_started.rst
   resource/research/computer_basics.rst
   resource/research/job_and_career.rst
   resource/research/writing_paper.rst
   stats_data_ml.rst


Astronomy, Astrophysics, & Cosmology
------------------------------------

.. toctree::
   :maxdepth: 1

   resource/astro/astro_readme.rst
   resource/astro/astro_research_basic.rst
   astro_topic.rst
   astro_project.rst
   astro_reading.rst

Programing and Developing Software
----------------------------------

.. toctree::
   :maxdepth: 1
   
   python.rst
   resource/programing/clang_basic.rst
   resource/programing/cpp_basic.rst
   resource/programing/julia_basic.rst
   resource/programing/numerical_method.rst

中文内容 (Material in Chinese)
------------------------------

.. toctree::
   :maxdepth: 2

   resource/research/getting_started_cn.rst

Motivation and Goals
--------------------

* Over the past ~10 years, I have gradually accumulated some useful resources for 
  astrophysical research and I believe the best way to make use of these information is 
  to share them.
* The name ``taotie`` (饕餮) refers to a greedy and gluttonous monster in ancient Chinese myth. 
  It is indeed very greedy and over-ambitious to collect all useful resources for astrophysics 
  and cosmology.
* **The goal of ``taotie``** is to become a curated list of resources for astronomy and 
  astrophysics maintained by the community. Just like many other ``awesome`` lists available 
  on ``GitHub``. We hope ``taotie`` can become the first stop for new student or researcher in 
  astronomy to seek for practical guidance and experience.  
  And ``taotie`` can also be a handy and organized "bookmark" for researchers in different fields.

Progress and Plans
------------------

* **Under Construction**: This repo is still under heavy and frequent development. 
  I am currently working on this as a weekend project.
* Currently working on improving the collections of ``taotie``, especially for research fields 
  outside my personal comfort zone. **Any help will be highly appreciated!**
* Also working on improving the presentation by making a user-friendly website based on a list 
  of markdown files.

On Using ``taotie`` (饕餮)
--------------------------

* Now ``taotie`` is available on both `GitHub <https://github.com/dr-guangtou/taotie>`_ 
  and `GitLab <https://gitlab.com/dr-guangtou/taotie>`_.  
  And you can also find ``taotie`` using `this address <https://dr-guangtou.github.io/taotie/>`_
* For users in mainland China: in case the ``Github`` link below is not available, 
  please replace ``github`` with ``gitlab`` and try again. 
  **Please let me know if you have trouble accessing both sites**.
* The main language for ``taotie`` is English. Some of the important documents will be slowly 
  translated into Chinese.
* **Please let me know if you have any suggestion or recommendation**.

Contribution
============

* Contribution from the community is highly welcomed! Please feel free to fork the repo and 
  make you own change. 
  If you want your modifications be included in this repo, please submit a pull request 
  (and make sure to describe the changes you made).
* And if you notice anything wrong with the current content (wrong or unavailable link for example), 
  please raise an issue.
* Also, if your repo or project is included here and you are not comfortable with that, just 
  let me know.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`