Switch 2.0.5 (csv import/export)

CHANGELOG.txt → CHANGELOG.md

@@ -1,3 +1,31 @@
+-------------------------------------------------------------------------------
+Switch 2.0.5
+-------------------------------------------------------------------------------
+This release standardizes all inputs and outputs as .csv files.
+
+As usual, when  you first solve an older model, Switch will prompt to backup and
+upgrade the  inputs directory. If you accept, it will convert the existing
+tab-delimited *.tab files and most ampl-format *.dat files to comma-delimited
+*.csv files. It is recommended that you update your model data preparation
+scripts to create .csv files directly. Note that non-indexed parameters should
+now be stored in .csv files with a header row listing the parameter names and a
+single data row showing their values.
+
+All multi-value outputs from Switch are also now in comma-delimited .csv files,
+instead of a mix of .csv, .tab and .txt files. (total_cost.txt is unchanged)
+
+This release also includes includes the following minor updates:
+
+- Updated installation instructions
+- Switch version number and website are now shown in the startup banner when
+  running with --verbose flag; solve messages have also been improved slightly
+- Some parsing errors for *.tab files have been fixed in the upgrade scripts;
+  this may cause errors during the upgrade process for input files that use
+  spaces instead of tabs and were previously upgraded by Switch, producing
+  malformed files.
+- Fixed several bugs in the documentation and execution of the stochastic
+  examples that use the PySP module of the Pyomo package
+
 -------------------------------------------------------------------------------
 Switch 2.0.4
 -------------------------------------------------------------------------------

DEV_INSTALL.txt

@@ -40,18 +40,33 @@ INSTALLATION WITH PYTHON VIRTUAL ENVIRONMENTS FOR DEVELOPMENT
         git clone https://github.com/switch-model/switch.git "$SRC_DIR"
 
 4. Create a virtual environment in your project directory, and install switch
-   and its prerequisites.
+   and its prerequisites (if using Windows, replace "bin" with "Scripts"):
         cd "$PROJECT_DIR"
         pip install virtualenv
         virtualenv venv
         source venv/bin/activate
-        pip install --editable "$SRC_DIR"
+        pip install --editable "$SRC_DIR"[extra_requirements]
 
-   Note: The --editable flag ensures that any changes to your downloaded copy
+   Remember to replace "extra_requirements" with a comma-separated list with
+   the extra dependencies you will be using for your development:
+        database_access: Used to access Hawaii data from Matthias.
+        advanced:        Used for advanced demand response and progressive
+                         hedging modules.
+        plotting:        Self explanatory.
+        dev:             Used for debugging.
+
+   Note 1: The --editable flag ensures that any changes to your downloaded copy
    of switch will be immediately reflected to your installed copy in the
    virtual environment.
 
-5. Record the exact version of every library you are using so you can 
+   Note 2: If installing advanced dependencies in a Windows OS using pip, the
+   installation of r2py may raise an error. The simplest workaround is to
+   follow the steps outlined here: https://stackoverflow.com/a/32983656
+   After manually installing r2py, you can proceed to repeat the installation
+   of Switch with the advanced dependencies using:
+        pip install --editable "$SRC_DIR"[extra_requirements]
+
+5. [Optional] Record the exact version of every library you are using so you can 
    precisely replicate this setup in the future. 
         pip freeze > requirements.txt
    Without this step, you are at higher risk of not being able to readily
@@ -68,3 +83,6 @@ EXECUTION
        source venv/bin/activate
 3. Execute switch like normal
        switch solve ...
+4. When finished development work, remember to leave the virtual
+   environment with the following command:
+       deactivate