Merge pull request #2 from chrisyeh96/journal

Nonlinear simulation merge

README.md

@@ -7,13 +7,27 @@
 
 **California Institute of Technology and UC San Diego**
 
+## Getting started
+
+### Install packages
+
+1. Install [miniconda3](https://docs.conda.io/en/latest/miniconda.html).
+2. Install the `voltctrl` conda environment:
+    ```bash
+    conda env update -f env.yml --prune
+    ```
+3. Request a Mosek license ([link](https://www.mosek.com/products/academic-licenses/)). Upon receiving the license file (`mosek.lic`) in an email, create a folder `~/mosek` and copy the license file into that folder.
+
+### Running voltage control experiments
+
+TODO
 
 ## Data Files (in `/data`)
 
 The original data files were provided by the authors of the following paper:
 > Guannan Qu and Na Li. 2020. Optimal Distributed Feedback Voltage Control under Limited Reactive Power. _IEEE Transactions on Power Systems_ 35, 1 (Jan. 2020), 315–331. https://doi.org/10.1109/TPWRS.2019.2931685
 
-The original data files ("orig_data.zip") are attached to the [releases](https://github.com/chrisyeh96/voltctrl/releases/tag/v1.0). These original data files have been processed into the following files, which are the only files relevant for our experiments. See the inspect_matlab_data.ipynb notebook for details.
+The original data files ("orig_data.zip") are attached to the [releases](https://github.com/chrisyeh96/voltctrl/releases/tag/v1.0). These original data files have been processed into the following files, which are the main files relevant for our experiments. See the [inspect_matlab_data.ipynb](notebooks/inspect_data.ipynb) notebook for details.
 
 **PV.mat**
 - contains single key `'actual_PV_profile'`
@@ -57,6 +71,12 @@ The original data files ("orig_data.zip") are attached to the [releases](https:/
     - 'branch': shape [55, 13], type float64
     - 'gen': shape [1, 21], type int16
 
+**nonlinear_voltage_baseline.npy**
+- float64 array, shape [14421, 56]
+- description: balanced AC nonlinear simulation voltages, generated by [nonlinear_no_control.py](nonlinear_no_control.py)
+- each column is the voltage of a bus, with column 0 being bus 0 (the substation)
+- units: p.u. voltage (multiply by 12 to get kV)
+
 See the attachment in [releases](https://github.com/chrisyeh96/voltctrl/releases/tag/v1.0) for Python `.pkl` files containing the results of running the various algorithms. These Pickle files are read by the various Jupyter notebooks for plotting and analysis.