********************
zenopy Documentation
********************

.. figure:: images/molssi-zenopy.png
  :align: center
  :scale: 60%
  :alt: zenopy logo

Welcome to ``zenopy's`` documentation.

``zenopy`` is an open-source python library that exposes the all functionalities
of the `Zenodo <https://zenodo.org>`_ API to researchers and software developers.

This package is a part of the data engineering domain infrastructure in the Chem-AI
software ecosystem.

.. grid:: 1 1 2 2

   .. grid-item-card:: Quick Start
      :margin: 0 3 0 0

      Jump right into using zenopy!

      .. button-link:: ./quick_start.html
        :color: primary
        :expand:

        Quick Start Guide

   .. grid-item-card::  How-to Guides
      :margin: 0 3 0 0

      A collection of How-to Guides for busy users

      .. button-link:: ./howtos/index.html
        :color: primary
        :expand:

        How-to Guides

   .. grid-item-card:: API Reference
      :margin: 0 3 0 0

      Application programming interface (API) references

      .. button-link:: ./api/index.html
        :color: primary
        :expand:

        API Reference

   .. grid-item-card::  Developer Guide
      :margin: 0 3 0 0

      Deeper insights into zenopy infrastructure

      .. button-link:: ./tutorials/index.html
        :color: primary
        :expand:

        Developer Guide

.. Table of Contents
.. toctree::
    :hidden:
    :titlesonly:

    installation
    quick_start
    howtos/index
    tutorials/index
    interactive
    manual/index
    api/index
    references
    dev_team
    acknowledgements

.. list-table:: **Stay in Touch**
   :widths: 20 12 20 18
   :header-rows: 1
   :align: center

   * - Slack
     - GitHub
     - Zenodo Community
     - MolSSI Guidelines
   * - |Slack|
     - |GitHub|
     - |Zenodo|
     - |MolSSI|


.. Badge(s)
.. |Slack| image:: https://upload.wikimedia.org/wikipedia/commons/b/b9/Slack_Technologies_Logo.svg
   :target: https://join.slack.com/t/zenopy/shared_invite/zt-1ifpoehxy-BRThIqLImB4sXUVKSYgOWQ
   :alt: zenopy Slack Channel
   :width: 170

.. |GitHub| image:: https://upload.wikimedia.org/wikipedia/commons/9/91/Octicons-mark-github.svg
   :target: https://github.com/MolSSI/zenopy
   :alt: zenopy GitHub Repository
   :width: 90

.. |Zenodo| image:: https://about.zenodo.org/static/img/logos/zenodo-gradient-square.svg
   :target: https://zenodo.org/communities/molssi/
   :alt: MolSSI Zenodo Community
   :width: 170

.. |MolSSI| image:: https://raw.githubusercontent.com/MolSSI/molssi-branding-guidelines/master/logos/main_logo/molssi_main.svg
   :target: https://molssi-ai.github.io/molssi-ai-guidelines/index.html
   :alt: MolSSI Guidelines and Best Practices
   :width: 150