.. _aequilibrae_project:

AequilibraE Project
===================

This page is dedicated to a practical implementation of the AequilibraE project. In case you
are interested in better understanding its structure, please visit its 
`documentation <https://www.aequilibrae.com/develop/python/modeling_with_aequilibrae/project.html>`_
webpage.

Under the project menu, there are some options to choose from and the following sections
explore some of these actions.

.. image:: ../images/project_procedures/menu_project.png
    :align: center
    :alt: tab project menu

.. _open_and_close_project:

Open & Close project
--------------------

These options are pretty straightforward and are used either to open or close a
project. You just have to click **Project > Open project** to open
a project, and **Project > Close project** to close it.

Keep in mind that to open another project or to create a new one, you **must**
close the currently open project, otherwise AequilibraE is going to return an
error.

.. _run_procedures:

Run procedures
--------------

The run procedures allows you to define model entry points and their default arguments, and run models
to the model itself. Usage at QAequilibraE is pretty straightforward: select one of the available
functions, click on the *Run!* button, and wait for the log file to open with the output results of
the model.

To better understand the application of the run module, we encourage you to read about it at 
`the AequilibraE documentation <https://www.aequilibrae.com/develop/python/run_module.html>`_.

.. image:: ../images/project_procedures/run_module_dialog.png
    :align: center
    :alt: run module dialog

.. Video tutorial
.. --------------

.. If you want a summary of everything that was presented on this page, you can
.. head over to YouTube to see a demonstration of how to download these projects.

.. .. raw:: html

..     <iframe width="560" height="315" src="https://www.youtube.com/embed/9PF2qHs2hUc"
..      frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope;
..      picture-in-picture" allowfullscreen></iframe>