.. _python_api:

.. currentmodule:: flow360

****************
Python API
****************

.. image:: https://img.shields.io/badge/pypi-flow360-blue?style=for-the-badge
   :target: https://pypi.python.org/pypi/flow360
.. image:: https://img.shields.io/pypi/v/flow360.svg?style=for-the-badge
   :target: https://pypi.python.org/pypi/flow360/
.. image:: https://readthedocs.com/projects/flexcompute-flow360documentation/badge/?version=latest&style=for-the-badge
   :target: https://flexcompute-flow360documentation.readthedocs-hosted.com/?badge=latest
.. image:: https://img.shields.io/github/license/flexcompute/flow360?style=for-the-badge
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge
   :target: https://github.com/psf/black

This section aims to provide the required information to start using the API in :ref:`getting started <python_api_setup>` guide. 
Find quick snippets of codes for different features and common operations in :ref:`project management <python_api_grab_and_go_snippets>`. 
For well explained tutorials for specific applications go to the :ref:`example library <python_api_example_library>`.

.. toctree::
   :maxdepth: 1

   getting_started/installation_setup
   grab_and_go_snippets/index
   example_library/index
   migration_guide/index
   API_reference/index