# Simple repository for reproducibility: Python

This is a repository that runs a small test script using a network
library. See the corresponding publication under XYZ.

## Structure

The repository contains the `main.py` which runs the main script and the
`test.py` which is used for testing the install. Any data is contained
inside the data directory and will be automatically loaded by the
installation script.

## Installation

1.  Download the repository:

    ``` shell
    git clone https://<the-repository>/some/path.git
    ```

2. Move into the directory of the cloned folder.

3. Create the virtual environment.

    ``` shell
    python -m venv .venv
    ```

4.  Activate the environment:

    - Linux & Mac

      ``` shell
      source .venv/bin/activate
      ```

    - Windows (cmd.exe):

      ``` shell
      .venv/Scripts/activate.bat
      ```

    - Windows (Powershell)

      ``` shell
      .venv/Scripts/activate.ps1
      ```

5. Install the requirements with pip:

    ``` shell
    pip install -r ./requirements.txt
    ```

6.  Run the test script to test the environment:

    ``` shell
    python ./test.py
    ```

## Data

No data is required for running this script.

## Run the main script

Ensure, that you successfully completed the installation process. After this the command should run succesfully:

    ``` shell
    python ./main.py
    ```

The successfull run should produce a `graph.png` in the current directory containing a simple graph.