Snlquest

Merged WIP of Data Manager.

QuESt
General
* Due to data downloader issues, ISO-NE support will be considered experimental at this time. It will likely be removed from the release version.

QuESt Data Manager
* ISO/RTO data downloader general interface has been implemented.
* Temporarily, data will be downloaded to a separate `./data/` directory (rather than `./data_bank/`) for testing and development. Therefore, it will not impact data saved in the old data_bank or operation of the Valuation application.
* ERCOT data downloader has been implemented.
* ISO-NE data downloader has been generally implemented. However, due to connection issues with the API, it is not considered complete.

QuESt Valuation
* "Pro forma" report generation from the wizard has been implemented.

Resolved issues
* An issue where simulations with PJM models would crash the program.
* An issue where exporting to CSV from the results viewer would crash the program.

Known issues
* ISO-NE API

QuESt
General
* Implemented font and color changes according to graphics design update.
* Added copyright notice to landing screen.

Resolved issues
* An issue where values set for `fraction_reg_up` and `fraction_reg_down` after ValuationOptimizer object instantiation were being ignored and defaults were being used.

The selected name and tagline QuESt: Optimizing Energy Storage has been implemented. This patch addresses much of the feedback received during R1 of usability testing.

Valuation Optimizer
* Added check for self-discharge/conversion efficiencies: If value > 1.0, it is interpreted as percentage. Equalities/inequalities still use unit of fractions.
* Added electricity prices to results dataframe.
* Added bad parameter checking.
* Renamed `S_max` to `Energy_capacity`.
* Removed `S_min` in favor of `Reserve_charge_min` (in terms of fraction of energy capacity).
* Renamed `Storage_efficiency` to `Self_discharge_efficiency`.
* Renamed `Conversion_efficiency` to `Round_trip_efficiency`.

QuESt
Codebase
* `main.py` has been moved to the repository root.
* Directory references like `\x\y\z.file` have been changed to `os.path.join(x, y, z.file)` when possible. (.py files)

General
* "Select market formulation" has been changed to "Select revenue streams".
* The default and minimum window size has been increased to 1600x900.
* Font sizes have been increased.
* The appearance of spinners/dropdowns have been adjusted to be more recognizable.
* The color, width, and activity behavior of the scroll bar in scroll views have been adjusted for visibility.
* Keyboard shortcuts partially implemented. Enter or NumpadEnter keys can now be used to close most warning popups (typically popups with only a single button for closing them).
* The keyboard shortcut for exiting the application (Esc) has been disabled.
* Efficiencies have been given display units of (%/h) and value ranges have been adjusted accordingly.
* Maximum state of charge has been renamed to "energy capacity (MWh)."
* Added select-all behavior when tabbing among text input fields.

Landing screen
* The "About", "Settings", and "Help" buttons on the landing screen have been moved to the top navigation bar.
* They will remain consistently at the beginning of the navigation button sequence.
* The "Quit" button has been removed.
* The landing screen layout has been slightly adjusted to increase the call to action for proceeding.

Settings
* The "Settings" screen has been converted to a modal view with a sidebar menu interface.
* It is now accessible from any screen.

Single Run
* The parameter entry widget has been changed to a three column grid layout to match the batch runs tool.
* The "run optimization" popup text has been adjusted.
* Interface when completing runs matches that of batch run.
* The node selector interface has been adjusted.

Batch Runs
* The look and feel has been adjusted to facilitate the logical order of progression.
* The month/data and pricing node selection RV's have their alpha values set to 0.05 until both a market area and revenue streams are selected.
* Changing the market area will reset the alpha values back and reset the revenue stream selection.
* The parameter sweep selection spinner now displays "Select a parameter to sweep" by default.
* A warning now appears if you try to run a batch when anything in the parameter sweep range text input fields is entered but no parameter is specified.
* Upon completion of a batch, a button can take you to the results viewer.

Results Viewer
* "View Results" has been renamed to "Results Viewer"
* The "Results Viewer" screen has been redesigned.
* No axes are displayed until a plot is actually drawn.
* The toolbar has been condensed.
* The run selector has been implemented directly into the results viewer interface.
* The run names contain most information about the specific run, including all parameters set differently from defaults.
* The hover behavior has been removed.
* The time selector has been implemented directly into the results viewer interface.
* Pressing Enter/NumpadEnter after entering into the text inputs now automatically calls Plot/Redraw.
* The plot figure layout has been adjusted.
* The legend has been moved to outside the plot.
* In accordance with the run name adjustments, the legend label now displays more information.
* With the potential of extremely long legend labels, the amount of simultaneous traces that can be comfortably displayed may be affected.
* All plots have been changed to "stair"/"step" plots.
* Major grid lines have been implemented.
* x-axis labels have been changed to "ending hour."
* Additional spacing between legend entries has been added.
* A "Deselect all" button has been added for the run selector.
* Leaving the results viewer completely resets it, including removing the active plot, deselecting any run selections, and reverting time selectors to defaults.
* Added plot options for electricity prices (line and box plots).

Wizard
* The sequence of screens has been adjusted.
* ISO select, rev. stream select, device select, data select, node select -> ISO select, node select, rev. stream select, data select, node select
* The minimum state of charge (MWh) parameter setter has been removed.
* Filter by node name text input has been implemented.
* Node ID and name description has been removed.

Report
* The names of reports have been adjusted.
* Activity (by source) -> Participation (by month)
* Activity (%, total) -> Participation (total)
* Report titles and text have been adjusted accordingly.
* The activity stacked bar chart (non-normalized) has been removed.
* Certain additional words have been bolded in report text.

Resolved Issues

Known Issues

Resolved issues
* An issue where ISO-NE simulations would not properly handle an exception due to an exception class not available in Python 2.x, leading to an UnboundLocalError.

Systems

Software tool
* The summary of selections screen for the valuation wizard has been implemented.

Resolved issues
* An issue where an ImportError would occur for op_handler when the application was executed outside of an IDE project.

This patch brings an extensive visual design overhaul and a number of redesigned features.

Systems

Valuation Optimizer
* A single "power rating (Q_max)" has been implemented to replace max charge/discharge ratings (Q_r_max and Q_d_max, respectively).
* Constraints have been replaced accordingly.
* Reserve_charge and Reserve_reg parameters have been split into scalar parameters.
* Reserve_charge_min, Reserve_charge_max, Reserve_reg_min, Reserver_reg_max

Data
* The node list for ISO-NE has been reduced to 8 "zones."
* April 2015-November 2017 have been added as options for ISO-NE.
* PJM for H2 2017 has been added. Options for it in the GUI have been added as well.
* PJM and MISO price node selection has been reduced.

Software tool
* Compatibility for Python versions prior to 3.0 will no longer be checked.
* New fonts and palette implemented. Subject to change as software branding is developed.
* Animations and transitions have been generally sped up.
* Numerous "content definitions" that were previously hard-coded have been factored out into definition .json files (/es_gui/apps/valuation/definition/). This is aimed at centralizing content changes; e.g., if new sets of historical data are added, we can update all the UI changes by adjusting these definitions, rather than changing hardcoded values in numerous files.

* The landing/index screen has been redesigned.
* The help link has been removed, pending an overhaul.
* The about screen has been redesigned into a popup.
* The welcome splash screen has been removed.
* The settings panel has been updated.
* Removed setting regarding welcome splash screen.
* Added category headers.
* Added settings regarding the Valuation data cache.

* ValuationDMS object persistence has been implemented. This allows for the preservation of the ValuationDMS's loaded data, even when the software tool has been closed and reopened. The maximum size of the persisting object, as well as the feature as a whole, can be adjusted in the settings panel.

NOTE: This object is stored as a pickle (/es_gui/valuation_dms.p) and is not compatible between Python versions. If you encounter errors upon software initialization regarding inability to read the pickle, delete the file.

* Several visual design adjustments to the Valuation Wizard have been made.
* Selection of "revenue streams" has become selection of "market formulation."

* A "ValuationOptimizationHandler" class has been implemented. This class consolidates a lot of behavior that was spread across numerous objects. Its function is to receive sets of instructions and interpret them to load the appropriate data and create and solve the ValOptimizer models as requested. It also handles access to solved models.
* Essentially, other objects just need to generate the instructions and send it to the ValOpHandler. It's the ValOpHandler's responsibility to handle interactions with the DMS and ValOptimizer instances. This is also aimed at centralizing content-specific changes; e.g., if a new market type is implemented in ValOptimizer, only the ValOpHandler needs to know how to use it.

* The Batch Runs screen has been redesigned.
* Market-specific "static" parameter input fields have been implemented.

* The View Results screen has been adjusted.
* Selecting a data type to display no longer automatically redraws the plot.
* Closing the "time selector" popup no longer automatically redraws the plot.
* "Plot/Redraw" must be pressed to update the graph.

* The Load Data screen has been adjusted.
* Arrow buttons have been added.
* Loading data is no longer actually handled on this screen.
* It has been renamed "Select Data" in the GUI to reflect these changes.

* The Set Parameters screen has been redesigned.
* The parameters displayed dynamically change when entering the screen, based on the market area selected in the Load Data screen.
* No button required to explicitly set values.

* The flow of the single month valuation run has been adjusted.
* The valuation run that is performed is based on whatever is displayed in the UI upon execution. The UI does not reset after execution.
* Due to back end changes, background threading of certain tasks has been removed.

* The menu structure of the Energy Storage Valuation application has been adjusted.
* The landing screen presents three options for simulation: Wizard, Single Run, and Batch Runs. It presents one option for analysis: View Results.
* Batch Runs and Wizard lead directly to their interfaces.
* Single Run leads directly to Select Data and only links to Set Parameters and View Results.

Resolved issues
* An issue where the run selector on the View Results screen would fail to identify that runs have been selected for viewing.
* An issue where the description text for the activity donut report chart would not be fully displayed.