search

pnnl / i2x

Interconnection Innovation e-Xchange (i2x) Test Systems
Other
8 stars 13 forks source link

Data Hub Pull Request #19

Closed varoozhan closed 11 months ago

varoozhan commented 12 months ago

from workflow branch of varoozhan/i2x fork to pnnl/i2x develop branch.

eranschweitzer commented 12 months ago

Seems good to me. One question: I can't quite figure out at first glance whether the functions pull the data directly or whether we first need to download some csv file and then the functions read these.

varoozhan commented 12 months ago

@eranschweitzer I put instructions on the Readthedocs (which I understand it may take a few hours to update) under i2x/docs/datahub.rst file. I will double check to make sure it is adequate.

To answer your question: No, you do not need to download anything. If you want to run the datahub, you can clone the repo and after installing the i2x/data/requirements.txt (the req.txt inside the data folder) you can just run the main.py file to start the script. Otherwise, you can also make modification to any of the input files under i2x/hubdata/input and push the changes back to the repo. The GitHub Actions workflow will automatically be triggered (this will take 1 to 1.5 hours) and after it has run the script, the results will automatically be updated under i2x/hubdata/output.

To test this, you can remove a row from say i2x/hubdata/input/queues_2021_clean_data.xlsx and do a git add/commit/push. Once the push is successful, you can see the workflow under "Actions" tab within the repo.