Changeset 3059


Ignore:
Timestamp:
Sep 30, 2010 6:25:25 PM (11 years ago)
Author:
dlwoodr
Message:

Added most of the new command line options and made a few minor edits. Changed the version given as the title to 1.11 (from 1.1).

Location:
coopr.pysp/trunk/doc/pysp
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • coopr.pysp/trunk/doc/pysp/pyspbody.tex

    r2809 r3059  
    146146  Show help message and exit.
    147147
     148  \item \verb|--model-directory|=MODEL\_DIRECTORY                            \\
     149  The directory in which all model (reference and scenario) definitions are
     150  stored. I.e., the ``.py'' files. Default is ".".
     151
     152  \item \verb|--instance-directory|=INSTANCE\_DIRECTORY                      \\
     153  The directory in which all instance (reference and scenario) definitions are
     154  stored. I.e., the ``.dat'' files. Default is ".".
     155
    148156  \item \verb|--verbose|                                                     \\
    149157  Generate verbose output for both initialization and execution. Default is
     
    157165  Always report PH weights prior to each iteration. Enabled if --verbose is
    158166  enabled. Default is False.
    159 
    160   \item \verb|--model-directory|=MODEL\_DIRECTORY                            \\
    161   The directory in which all model (reference and scenario) definitions are
    162   stored. I.e., the ``.py'' files. Default is ".".
    163 
    164   \item \verb|--instance-directory|=INSTANCE\_DIRECTORY                      \\
    165   The directory in which all instance (reference and scenario) definitions are
    166   stored. I.e., the ``.dat'' files. Default is ".".
     167 
     168  \item \verb|--report-only-statistics|                                      \\
     169     When reporting solutions (i.e. if --report-solutions has been selected), only output per-variable statistics - not the individual scenario values. Default is False.
    167170
    168171  \item \verb|--solver|=SOLVER\_TYPE                                         \\
     
    261264  \item \verb|--output-solver-logs|                                          \\
    262265  Output solver logs during scenario sub-problem solves. Default: no output.
     266
     267  \item \verb|--output-scenario-tree-solution|                                 \\
     268     Report the full solution (including the leaves) in scenario tree format upon termination. Values at non-leaf nodes represent averages. Default is False.
    263269
    264270  \item \verb|--output-ef-solver-log|                                        \\
     
    310316  bounds can be based on data from all scenarios. The config subdirectory of the
    311317  farmer example contains a simple example of such a file (boundsetter.cfg).
     318
     319  \item \verb|--ef-mipgap|=MIPGAP \\
     320     Specifies the mipgap for the EF solve (if there is an ef solve).
    312321
    313322  \item \verb|--checkpoint-interval|                                         \\
     
    11431152\subsection{wwph.cfg}
    11441153
    1145 This file provides default values. Even though most of them will be overridden
     1154This file overrides default values for the suffixes used by WW PH Extension. Even when most of them will be overridden
    11461155at the variable level, it makes sense to provide instance specific defaults. For
    11471156this problem, it does not seem helpful or prudent to do any fixing of continuous
  • coopr.pysp/trunk/doc/pysp/pyspdoc.tex

    r1808 r3059  
    2020\begin{document}
    2121
    22 \title{PYSP Version 1.1\\
     22\title{PYSP Version 1.11\\
    2323User Documentation}
    2424
Note: See TracChangeset for help on using the changeset viewer.