Projects
========

Assuming you already registered, the recommended workflow consists in:

 1. Creating a Project
 2. Preparing your first run by downloading our Excel template, and filling it as
    per your layout.
 3. Creating and running a new decompression analysis



.. _create_project_phase:

Creating a project
------------------

If needed, create a new project from the main ``projects`` menu:
Projects>>Create Project.

Fill-in the form to create a project, then save it. The Project's Creation Form 
is organized in three sections: (1) Aircraft Data, (2)Project's Team and (3)
Decompression Runs Default Parameters.




Aircraft's data and Project's team
----------------------------------



.. _create_project:
.. figure:: fig/create_project_01.png
    :align: center
    :alt: Create a project
    :figclass: align-center
    :width: 400pt
    :class: screenshot

    Project's creation Form --(1/2) Aircraft Data & Project's team --

The two first sections of the form aims to provide general information about
the Aircraft and the team.

As shown in :numref:`create_project`

1. ``Name`` Name of the project 
2. ``AC family`` Aircraft type (*eg.* A320, A330, B747, *etc.*)
3. ``Aircraft`` Aircraft type (A319CJ, A330-200, B747-8, *etc.*)
4. ``Decks Mapping`` Association of deck levels with deck names
5. ``Admins`` (optional) list of users allowed to perform administraor tasks
6. ``Users`` (optional) list of allowed users

.. note:: Once the project is validated, the "decks mapping" (item 4) cannot be
        changed anymore

Decompression Runs Default Parameters
-------------------------------------


.. _create_project_parameters:
.. figure:: fig/create_project_02.png
    :align: center
    :alt: Create a project
    :figclass: align-center
    :width: 400pt
    :class: screenshot

    Project's creation Form --(2/2) Decompression Runs Default Parameters --

As shown in :numref:`create_project_parameters`


Additionnally, some default parameters for runs are to be provided. Those
parameters will be proposed by default for each new analysis of the project.

1. ``Units`` Set of units in which the model and analysis results are given
2. ``Engine`` Thermodynamical engine to use
3. ``Polytropic constant`` provide (optionally) the relevant poly tropic constant.
4. ``Doors position`` Which initial condition (:term:`configuration`) to use.
5. ``timestep`` Simulation time increment. .
6. ``sampling`` Data sampling for disk storage. 
7. ``timeout`` Simulation maximum time.
8. ``Default opening latency`` Set a default latency for opening feature.

Deleting a project
------------------

Deleting a project is authorized for the author of the project only.  To delete
a project, click on the trash icon as shown in :numref:`delete_project`.


.. _delete_project:
.. figure:: fig/deleting_project.png
    :align: center
    :alt: Deleting a project
    :figclass: align-center
    :class: screenshot
    :width: 300pt

    Deleting a project

Managing a project
------------------

From the projects list overview, the user can enter a project by clicking on the
project name (*cf.* :numref:`delete_project`)

Once in the project management: a blank project may look like this:

.. _blank_project:
.. figure:: fig/blank_project.png
    :align: center
    :alt: blank project 
    :figclass: align-center
    :class: screenshot
    :width: 400pt

    Blank project overview

as per :numref:`blank_project`:

1. ``Edit this Project``: open the Project's parameters form as
   :numref:`create_project``.
2. ``Delete this project``: delete the current project.
3. ``Check a model``: opens the form for model validation.
4. Folded panel hiding some details about the project. Click to unfold.
5. ``New Run`` button: Prepare and launch a new regular run within the project.

A project containing several :term:`nodes<node>` will display a list of
the existing nodes with additional informations.