.. pcf documentation master file, created by
   sphinx-quickstart on Mon Jan 29 13:34:22 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================================================
Welcome to Particle Cloud Framework's documentation!
====================================================

Overview
----------
Particle Cloud Framework is a cloud resource provisioning framework that is fully customizable and extensible, callable by code,
and does not require manually maintaining states of resources. Particle Cloud Framework enables the standardization of modeling
hierarchical cloud infrastructure, automating deployments, and managing lifecycles of cloud resources.



Installation
------------

To install particle cloud framework, open an interactive shell and run:

.. code::

    pip install pcf

.. note::

    Particle Cloud Framework requires python version 3.6 or higher.


User Quickstart
--------------------------

.. toctree::
   :maxdepth: 2

   sections/quickstart

Philosophy
--------------------------

.. toctree::
   :maxdepth: 2

   sections/philosophy

Framework Overview
--------------------------

.. toctree::
   :maxdepth: 2

   sections/framework

Particles
--------------------------

.. toctree::
   :maxdepth: 2

   particlelist

Quasiparticles
--------------------------

.. toctree::
   :maxdepth: 2

   quasiparticlelist

Features
--------------------------
.. toctree::
   :maxdepth: 2

   features/features

Core Concepts
--------------------------
.. toctree::
   :maxdepth: 2

   concepts/concepts
   
CLI Usage
--------------------------
.. toctree::
   :maxdepth: 2

   sections/cli

Core Classes
--------------------------

.. toctree::
   :maxdepth: 2

   sections/core

Examples
--------------------------

.. toctree::
   :maxdepth: 2

   examples/examples


Developer Quickstart
--------------------------

.. toctree::
   :maxdepth: 2

   sections/quickstartdeveloper


Roadmap
--------------------------

.. toctree::
   :maxdepth: 2

   sections/roadmap

Contributing to the Docs
--------------------------

.. toctree::
   :maxdepth: 2

   sections/cont



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

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