Home view
----------------

### Introduction

When connecting to Artelys Crystal Super Grid, the home page looks like this:
<div align="center">

![Home view](../../_static/home_view.png)

</div>

From this home menu, you can see all the studies you have access to:

- Classic studies are identified with this icon ![Classic study](../../_static/classic_studies.png)
- Scenarisation studies are identified with this icon ![Scenarisation study](../../_static/scenarisation_studies.png)


### Operations


#### Create study

<div align="center">

![Create study](../../_static/create_study.png)

</div>

- **Study name**: the name of the study you want to create. This name should be _unique_ on your server.
- **Study type**: the type of the study you want to create. You can choose between _STUDY_ (a study is a classic study 
where your represent an energy system during a continuous timescale) or _SCENARISATION_STUDY_ (a scenarisation study 
is a study where your represent the evolution of a long-term energy system).


#### Create context


<div align="center">

![Create context](../../_static/create_context.png)

</div>

This operation enables to create a new empty energy system on your server. The following parameters have to be filled by the 
user to perform the operation:

- **Context type**: select the context type of your new context. The context type depends on the study you select. 
  - If you want to simulate the energy system, choose _SIMULATION_ or _PATHWAY_SIMULATION_.
  - If you want to do a capacity expansion planning of your energy system, choose _OPTIM_CAPA_ or _PATHWAY_OPTIM_.
- **Context name**: choose the name of your energy system. This name should be _unique_ in the study you chose.
- **Timestep count**: choose the number of timesteps you want to represent for your energy system.
- **Timestep duration**: choose the duration in minutes of all the timesteps.
- **Start date**: choose the start date of the energy system you want to model.

<blockquote class="custom-hint">
  <h4>Modelling hint</h4>

  If you want to model an energy system for one year at an hourly resolution, keep 8760 for the _Timestep count_ field 
  and 60 for the _Timestep duration_ field.
</blockquote>


#### Import context


<div align="center">

![Import context](../../_static/import_context.png)

</div>

This operation enables to import an energy system on your server. The following parameters have to be filled by the 
user to perform the operation:

- **File**: select the zip file containing the energy system you want to import. See section _Structure of import files_ in [Energy system modelling](../usage/energy_system_modelling.md) for more details on the accepted files for this operation.
- Suffix to add to the context name (Optional): the name of you context is available in the CONTEXT.csv file of your zip. 
If you want to add a suffix to the name of your context, you can add something in this field. The name of the context will be : context_name + _ + suffix. This name must not already exist in the study you have chosen.


#### Import pathways

<div align="center">

![Import pathway](../../_static/import_pathway.png)

</div>

This operation enables to import a pathway energy system on your server. The following parameters have to be filled by the 
user to perform the operation:

- **File**: select the zip file containing the pathway you want to import. See section _Structure of import files_ in [Energy system modelling](../usage/energy_system_modelling.md) for more details on the accepted files for this operation.


#### Delete (study or context)

<div align="center">

![Delete](../../_static/delete_logo.png)

</div>

This operation enables to delete a study or a context. This action is not reversible.


#### Duplicate a context

<div align="center">

![Duplicate context](../../_static/duplicate_context.png)

</div>

This operation enables to duplicate the selected context in the same or in another study. The following parameters have to be filled by the 
user to perform the operation:

- **New context name**: choose the name of the context. This context name should be unique in the study you want to duplicate the context.
- **Study**: select the name of the study in which you want to duplicate your energy system.


### Other functionalities

Other functionalities are available on the top right of the window.

#### Home

<div align="center">

![Home view](../../_static/home_icon.png)

</div>

This button enables to come back to the home view.


#### Settings

<div align="center">

![Home view](../../_static/settings_icon.png)

</div>

For administrators only.

- Information : give some information on the software version.
- Download logs : enable to download logs to help support 
- Restart : enable to reload the backend of the server.

#### Documentation 

<div align="center">

![Home view](../../_static/documentation_icon.png)

</div>


#### Notifications

<div align="center">

![Home view](../../_static/notifications_icon.png)

</div>

This button gives access to notifications.