Installation
============

Requirements
------------
* Python 3.8+
* Dependencies:
    * numpy
    * pandas
    * networkx
    * matplotlib
    * scipy
    * prettytable
    * plotly
    * geopandas
    * pyyaml
    * shapely
    * svgwrite
    * kmedoids
    * scikit-learn

* Optional dependencies:
    * Mapping:
        * folium
    * Optimal power flow:  
        * pyomo
        * ipopt
    * Dash:
        * dash



Install from PyPI
-----------------
::

    pip install pyflow-acdc


Install from source
-------------------
::

    git clone https://github.com/adored-project/pyflow_acdc.git
    cd pyflow_acdc
    pip install -e .



Making Changes
--------------

1. Create a new branch for your changes::

    git checkout -b new-branch-name
    git push origin new-branch-name

2. To push your changes to the remote repository::

    git add .
    git commit -m "Description of your changes"
    git pull origin new-branch-name
    git push origin new-branch-name

3. To pull the latest changes from the remote repository::

    git pull origin main

.. note::
    To merge your changes into the main branch please contact the repository owner.

Additional Dependencies
------------------------

For Mapping functionality
^^^^^^^^^^^^^^^^^^^^^^^^^^
Install the following packages::

    pip install folium

For OPF functionality
^^^^^^^^^^^^^^^^^^^^^^
Install the following packages::

    pip install pyomo
    conda install -c conda-forge ipopt

For TEP functionality
^^^^^^^^^^^^^^^^^^^^^^
pyflow_acdc has to be installed and run in a Linux environment.

**System Requirements:**
bonmin needs to be installed on the Linux system first, then Python can use it.

    sudo apt update
    sudo apt install coinor-libbonmin-dev
   

Install bonmin on Linux::

    conda install -c conda-forge bonmin

**Note:** bonmin is only available through conda-forge, not pip. Make sure you have conda installed on your Linux system.


For Dash Interface
^^^^^^^^^^^^^^^^^^^
Install the following packages::

    pip install dash