DOCraven / Graphy

Repo to host some pandas data manipulation
0 stars 0 forks source link

RMIT CAPSTONE PROJECT

NORTH EAST WATER

Context

A program to assist in analysing NEW's industrial energy consumption. Takes xls files of interval data, and returns a number of different average load profiles.

Scope

Contains a GUI program that will:

This program includes NE Water data from External Sites and within WWTP.

VERSION

Version 1.6.3
Last Updated: 18MAY20

OVERVIEW

This program will generate a landing page to direct the user to two seperate GUI's.

  1. The first GUI will generate a percentage of consumption between two user defined hours. This can be viewed as a graph OR saved as a xlsx file with multiple sheets for multiple months. The expected output is a percentage (ie, 0-100%)

    • The output xlsx file can be found in /OUTPUT DATA
    • Outputs are as follows
      • Daily mean per month
      • Weekly Median per month
      • Solar generation available for external loads (ie, solar generation LESS WWTP LOAD) - This data is somewhat incomplete.
  2. The second GUI will plot daily and weekly average load profiles for WWTP and external NE Water loads. Various options exist for assisting in the analysis. Currently there is no option to export as a xlsx file. The expected output is a graph.

  3. There are ancillary functions to assist with other data manipulation. These are presented as external to the main graphy.py file, and require user input. Theses are as follows.

    • plotty.py will plot an xlsx or csv file and plot the existing data to match the format of the main Graphy.py. This is useful for data external to Graphy.py. This is presented as is, and will require user input, and it will break regularly.

How to use

  1. Clone the master branch.
    1. git clone https://github.com/DOCraven/Graphy.git.
  2. Install Dependencies (if required - PIP INSTALL [library]).
  3. In Visual Studio Code, open the folder that Graphy.py is located in via CTRL + K + O.
  4. Ensure the xls file is in the root folder (ie, same as Graphy.py).
  5. Run Graphy.py.
    • either within your IDE (in VS CODE, green triangle in Upper RH corner).
    • or via the terminal using python graphy.py.
  6. Use the included GUI landing page to select the various options.

Contributing

  1. Clone the master branch via git clone https://github.com/DOCraven/Graphy.git.
  2. Create a new branch either via git branch [branch-name] or via the inbuilt GitLens extension (bottom LH corner).
  3. Contribute code.
  4. commit code as necessary via git commit -m "Message" or via GitLens Extension.
  5. Push code to new branch via git push origin [your branch] or via GitLens Extension (bottom LH Corner).
  6. Request code review (if necessary).
  7. Merge with master when approved.

Known Issues

Dependencies

There are accompanying files required in order for this program to work. These files must be in the root directory.

There are multiple xlsx files in the /INPUT DATA folder required for this program to work properly.

Use PIP INSTALL [LIBRARY] to install each dependency.