.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2017 ZTE Corp.


########
Overview
########

QTIP uses Python as primary programming language. The structure of repository is based on the recommended sample in
`The Hitchhiker's Guide to Python`_

==============  ==========================================================================
Path            Content
==============  ==========================================================================
./benchmarks/   builtin benchmark assets including plan, QPI and metrics
./contrib/      independent project/plugin/code contributed to QTIP
./docker/       configuration for building Docker image for QTIP deployment
./docs/         release notes, user and developer documentation, design proposals
./legacy/       legacy obsoleted code that is unmaintained but kept for reference
./opt/          optional component, e.g. scripts to setup infrastructure services for QTIP
./qtip/         the actual package
./tests/        package functional and unit tests
./third-party/  third part included in QTIP project
==============  ==========================================================================

.. _The Hitchhiker's Guide to Python: http://python-guide-pt-br.readthedocs.io/en/latest/writing/structure/