.. pmcpy documentation master file, created by
   sphinx-quickstart on Wed Sep 22 23:22:29 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pmcpy: A Python package for PartMC post-processing
======================================================================================

|doi| |docs| |GitHub| |binder| |license| |pepy|

.. |doi| image:: https://zenodo.org/badge/409430865.svg
   :target: https://zenodo.org/badge/latestdoi/409430865

.. |docs| image:: https://readthedocs.org/projects/pmcpy/badge/?version=latest
   :target: https://pmcpy.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |GitHub| image:: https://img.shields.io/badge/GitHub-pmcpy-brightgreen.svg
   :target: https://github.com/zhonghua-zheng/pmcpy

.. |binder| image:: https://mybinder.org/badge_logo.svg
 :target: https://mybinder.org/v2/gh/zhonghua-zheng/pmcpy/HEAD?filepath=docs%2Fnotebooks

.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://github.com/zhonghua-zheng/pmcpy/blob/master/LICENSE
   
.. |pepy| image:: https://static.pepy.tech/personalized-badge/pmcpy?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads
   :target: https://pepy.tech/project/pmcpy

Author: `Dr. Zhonghua Zheng <https://zhonghua-zheng.github.io/>`_

.. toctree::
   :maxdepth: 2
   :caption: Overview

   pages/about.md
   pages/installation.md

.. toctree::
   :maxdepth: 2
   :caption: Tutorial

   notebooks/pmcpy_quickstart.ipynb
   notebooks/mixing_state_calculator.ipynb

.. toctree::
   :maxdepth: 2
   :caption: Reference
   
   notebooks/benchmarking.ipynb
   pages/partmc_sample_data.ipynb
   notebooks/particles_visualization.ipynb

How to ask for help
-------------------

The `GitHub issue tracker <https://github.com/zhonghua-zheng/pmcpy/issues>`_ is the primary place for bug reports.