=================
Project structure
=================

The project is organized according to the following folder structure:

.. code:: text

  <glow parent folder>
    ├── docs/
    ├── glow/
    ├── resources/
    ├── tests/
    ├── tutorials/
    ├── LICENSE
    └── README.rst


- ``docs``: contains the files for generating the project documentation with
  Sphinx;
- ``glow``: contains all the modules that provide the functionalities
  implemented by |TOOL|;
- ``resources``: contains files that support the configuration and operation
  of |TOOL|;
- ``tests``: contains both unit tests and functional tests, the former to ensure
  the correctness of individual code units, the latter to ensure the overall
  functionalities behave as expected;
- ``tutorials``: contains Python scripts that provide use cases showing how to
  use the |TOOL| functionalities for building different geometry layouts.