### **Setup**

- [Get permissions](#get-permissions)
- [Local setup](#local-setup)
  - [Get the codes](#get-the-codes)
  - [Connect with the input database](#connect-with-the-input-database)
  - [Prepare software & license](#prepare-software-license)
  - [Run Nexus-e](#run-nexus-e)
- [Euler setup](#euler-setup)

#### Get permissions

Before setting up, you need permissions to access the codes and the input database. Email the following people to ask for the corresponding permissions.

```Note:: |:warning:| Currently, the codes are only accessible with an ETH account.
```

- Xuejiao Han (xuhan@eeh.ee.ethz.ch): 
  - permission for the **DistIv** repository 
  - access to the **PSL server** for the database (server name: itet-psl-s02)
- Jared Garrison (garrison@fen.ethz.ch): 
  - permissions for the **eMark** repository
  - permissions for the **Shared** repository,
  - username and password for the **database** 
- Blazhe Gjorgiev (gblazhe@ethz.ch): 
  - permission for the **Cascades** repository
  - permission for the **Run_Nexuse** repository
- Elena Raycheva (elena.raycheva@esc.ethz.ch):
  - permission for the **CentIv** repository
- Florian Landis  (landisf@ethz.ch):
  - permission for the **GemEl** repository
- Xuqian Yan (xuqian.yan@esc.ethz.ch):
  - permission for the overarching **Nexus-e** repository (<https://gitlab.ethz.ch/xyan/nexus-e.git>)

#### Local setup

Most the instructions below have been tested both on **Windows** and on **Mac**.

#####  1. Get the codes

The instructions here use **command lines**. If you have a GUI tool for git, you could use the corresponding operations in the GUI tool instead. An example using a GUI tool "GitAhead" can be found in section [Nexus-e repository instructions](nexuse_repo_instruction.html).

- Create a folder where you want to put the codes

- cd to that folder

- Clone the overarching repository with this command:

  ```git clone --recursive https://gitlab.ethz.ch/xyan/nexus-e.git```

  You will be asked for your username and password for the repository and its submodules. Input your ETH username and password.

In the end, the folder will look like the screenshot below. Note: You might not see the hidden files whose names start with a dot; the `UserDBInfo.txt` file will be added in the sction [Connect with the input database](#connect-with-the-input-database); the `Results` folder will be automatically generated when you run Nexus-e.

![](images/nexus-e-folder.png)


##### 2. Connect with the input database

- Get access to the database  
Follow the section [Get permissions](#get-permissions) to get access to the database server (PSL server: itet-psl-s02) and your username & password for the database.

- Create a `UserDBInfo.txt` file in the folder where you put the codes as shown in [Get the codes](#get-the-codes). The file should contain four lines:
```
itet-psl-s02
3306
YOUR_DATABASE_USERNAME
YOUR_DATABASE_PASSWORD
```
An example can be found in `Shared/connectionInfoPSL.txt`.

- View the database
  - Install MySQL and MySQL Workbench
  - Connect to ETH VPN
  - Connect to the database with MySQL Workbench
    - Add a new MySQL connection  
    ![](images/mysql-workbench-1.png)
    - Input connection information  
    ![](images/mysql-workbench-2.png)
    - Click the button `Test Connection`. You will be asked to input your database password. Then you will see a seccess message:  
    ![](images/mysql-workbench-3.png)  
    ```eval_rst
    |:warning:| By default, everyone has write permission to the database. Therefore, to be safe, always make a local copy of the database before playing with it - i.e., first “Dump” it to a local folder, then import it to your personal MySQL account. These can be done in this window:  
    ```  
    ![](images/mysql-workbench-4.png)


##### 3. Prepare software & license

- **Matlab** (2018a or higher)

  - Set up database connector

    - Download the **MySQL connector** from [here](https://dev.mysql.com/downloads/connector/j/).  
    Or, if you have access to the Nexus-e polybox, use the `mysql-connector-java-8.0.18.zip` provided in the folder `02_Model/02_Model_Setup_Instruction`(**Unzip** the file before the next step).

    - Copy the MySQL connector folder (e.g. mysql-connector-java-8.0.18) into a folder at your preference.  
    We recommend to put it into the **Matlab preferences folder**, which you can find by typing in Matlab Command Window ```prefdir```.

    - Create a **javaclasspath.txt** file in the **Matlab preferences folder**.

    - In the **javaclasspath.txt** file, put the path to the connector .jar file.  
    E.g., On Blazhe's Windows computer the path is `C:\Users\gblazhe\AppData\Roaming\MathWorks\MATLAB\R2018a\mysql-connector-java-8.0.18\mysql-connector-java-8.0.18.jar`.

    - Reload Matlab
    
    - Test whether a database connector is set up successfully. Write the following commands in Matlab (substitue `YOUR_USERNAME` and `YOUR_PASSWORD` with your credentials for the database). If the second command returns `1`, it means success.  
    ```
    conn = database("sys", YOUR_USERNAME, YOUR_PASSWORD, 'Vendor', 'MySQL', 'Server', "itet-psl-s02");
    isopen(conn)
    ```
  
- **Python** (3.x)  
  ```eval_rst
  |:warning:| Note: we are now in the phase of transferring from python 2.x to python 3.x. Therefore, it is recommended to use python 3.x locally and identify potential issues for the transfer.

  ```  
  - Python packages: install the required packages listed in `requirements.txt`.
  - Gurobi (9.x): get a free Gurobi academic license <https://www.gurobi.com/academia/academic-program-and-licenses>
  - Python path: If you use Mac or if you want to run Nexus-e in a python virtual environment, you need to configure Python path in Matlab. Otherwise, you could skip this step. 
    - Make a copy of `user_path_example_conf.m` in the folder `Run_Nexuse`. Name the copy as `user_path_conf.m`. (Note: You should only work with the local copy, because the original `xxx_example_conf.m` will be synchronized to git and it shouldn't be changed.)
    - Find out your python path (it varies largely depending on your PC's operating system and how you installed python). Uncomment and adapt the variable `PATH_PYTHON` in `user_path_conf.m` accordingly.
    - If you have a python virtual environment, you could configure it following the instructions in `user_path_conf.m`.

- **GAMS**
  - Download from [here](https://www.gams.com/download/)
  - Set GAMS License
    - Use the `gamslice.txt` provided in polybox `02_Model/02_Model_Setup_Instruction`.
    - Install the license: [here](https://support.gams.com/installation:how_do_i_install_a_license_file) or [here](https://www.youtube.com/watch?v=vSe3YGkUVoc) or (for MacOS) [here](https://www.gams.com/latest/docs/UG_MAC_INSTALL.html).
  - GAMS path
    - If you haven't done so, make a copy of `user_path_example_conf.m` in the folder `Run_Nexuse`. Name the copy as `user_path_conf.m`. (Note: You should only work with the local copy, because the original `xxx_example_conf.m` will be synchronized to git and it shouldn't be changed.)
    - Find out your GAMS path (it varies largely depending on your PC's operating system and the version of GAMS). Uncomment and adapt the variable `PATH_GAMS` in `user_path_conf.m` accordingly.


##### 4. Run Nexus-e

- Connect to ETH VPN (in order to connect with the database)
- Open Matlab
- Run the script `run_Nexuse.m` in the `Run_Nexuse` folder
  - You could change the variables `scen`, `tpRes`, and `limDifference` as instructed in the script
  - Consult Blazhe Gjorgiev (gblazhe@ethz.ch) if you want to run other scripts in the `Run_Nexuse` folder.

#### Euler setup
##### 1. Join the usergroup

##### 2. Get the codes
##### 3. Prepare software & license
##### 4. Connect with the input database
##### 5. Run Nexus-e