Commit e14d2e4f authored by bonnell's avatar bonnell

Added ultra wrapper documentation to visit's help.

Cleaned up internal documentation for ultra wrapper.
Fixed bug with ultra-wrapper's 'save' command.
Updated Release notes with my changes.

git-svn-id: http://visit.ilight.com/svn/visit/trunk/src@12353 18c085ea-50e0-402c-830e-de6fd14e8384
parent a5f4c8bc
......@@ -381,6 +381,9 @@ QvisHelpWindow::ReleaseNotesFile() const
// Brad Whitlock, Thu Jun 19 16:39:30 PDT 2008
// Qt 4.
//
// Kathleen Bonnell, Sat Aug 28 13:17:45 MST 2010
// Added ultrawrapper document.
//
// ****************************************************************************
void
......@@ -425,6 +428,12 @@ QvisHelpWindow::LoadHelp(const QString &fileName)
contribPage->setData(0, Qt::UserRole, QVariant("contributors.html"));
contribPage->setIcon(0, helpIcon);
QTreeWidgetItem *ultraPage = new QTreeWidgetItem(
helpContents);
contribPage->setText(0, tr("VisIt UltraWrapper"));
contribPage->setData(0, Qt::UserRole, QVariant("ultrawrapper.html"));
contribPage->setIcon(0, helpIcon);
// Read the XML file and create the DOM tree. Then use the tree to
// build the User manual content.
bool noHelp = false;
......@@ -571,6 +580,7 @@ QvisHelpWindow::BuildIndex()
AddToIndex(tr("Command line arguments"), "args.html");
AddToIndex(tr("Frequently asked questions"), "faq.html");
AddToIndex(tr("FAQ"), "faq.html");
AddToIndex(tr("Ultra wrapper"), "ultrawrapper.html");
AddToIndex(tr("VisIt"), "home.html");
AddToIndex(tr("Release notes"), ReleaseNotesFile());
......
......@@ -88,6 +88,8 @@ enhancements and bug-fixes that were added to this release.</p>
<li>The <i>Curve</i> plot now can add cues to show a location along the curve. This is anticipated to be a useful feature when animating a curve within a movie.</li>
<li>The <i>Molecule</i> plot now supports 2D rendering primitives.</li>
<li>It is no longer necessary to press the <i>Enter</i> key before pressing the <i>Apply</i> button when changing the <i>Format template</i> text field in the <i>Label plot attributes</i> window for the change to take effect.</li>
<li>The point and symbol drawing options in the <i>Curve </i>plot have been combined, allowing them to be drawn independently of the curve lines.</li>
<li>There are two modes for drawing points/symbols for <i>Curve </i> plots: <b>static:</b> <i>use only nodes from the database</i>, and <b>dyanmic:</b> <i>fill in between the database nodes</i>. With <i>static</i> mode, a <i>stride </i>can be chosen which allows displaying only every <i>nth</i> node. With <i>dynamic </i> mode, a fill <i>density</i> can be chosen.</li>
</ul>
<a name="Operator_changes"></a>
......@@ -127,6 +129,8 @@ enhancements and bug-fixes that were added to this release.</p>
<li>Macro recording was changed so it generates a function name based on the name supplied for the macro. This eliminates a problem where giving a function name with invalid Python characters caused the macro to be discarded.</li>
<li>2D axis annotations are now correctly initialized from default annotation attributes.</li>
<li>The help text under <i>Working with databases->Supported File Types->File extensions</i>, which describes the order in which the database plugins are tried when attempting to open a file, is now current.</li>
<li>Updating macros can now be accomplished correctly on Windows.</li>
<li>Documentation for the Ultra Wrapper has been added to the help window.</li>
</ul>
<a name="Config_changes"></a>
......@@ -140,6 +144,9 @@ enhancements and bug-fixes that were added to this release.</p>
<li>All of VisIt's extents objects were renamed to better reflect their purpose. Also, extents calculations are performed less often.</li>
<li>build_visit now builds VisIt using Mesa 7.8.2.</li>
<li>build_visit now builds VisIt using VTK 5.0.0g. VTK 5.0.0g includes all the patches that were made by build_visit. Because of this it is possible to build VTK 5.0.0g on all our supported platforms without applying any patches.</li>
<li>If a host-specific config-site file is available on Windows, it will be used instead of the default windows.cmake.</li>
<li>Host-specific config-site files can be overriden by using -DVISIT_CONFIG_SITE="/path/to/config-site/file" from the CMake command line.</li>
<li>Default CMAKE_INSTALL_PREFIX on Windows can be overriden by specifying the value from the CMake command line. -DCMAKE_INSTALL_PREFIX="C:/desired/intstall/path"</li>
</ul>
<p>Click the following link to view the release notes for the previous version
......
This diff is collapsed.
......@@ -50,7 +50,7 @@ def AddMathOps():
else:
yc = "x"
usg = "Usage: %s <curve-list>" %cmd
proc = "Procedure: Take %s of %s values of curves" %(tempDict[cmd], yc)
proc = "Take %s of %s values of curves" %(tempDict[cmd], yc)
cmdHelp[cmd] = [proc, usg]
......@@ -68,27 +68,27 @@ def AddMathOps():
else:
log = ">"
usg = "Usage: %s <curve-list> <limit>" %cmd
proc = "Procedure: Filter out point in curves whose %s-values"%yc
proc = "Filter out point in curves whose %s-values"%yc
proc += " %s limit." % log
elif cmd == "powr" or cmd == "powrx":
usg = "Usage: %s <curve-list> <a>" %cmd
proc = "Procedure: Raise %s values of curves to a power, %s=%s^a"\
proc = "Raise %s values of curves to a power, %s=%s^a"\
%(yc,yc,yc)
elif cmd == "powa" or cmd == "powax":
usg = "Usage: %s <curve-list> <a>" %cmd
proc = "Procedure: Raise a to the power of the %s values of" %yc
proc = "Raise a to the power of the %s values of" %yc
proc += " curves, %s=a^%s" %(yc,yc)
else:
usg = "Usage: %s <curve-list> <value>" %cmd
proc = "Procedure: %s %s values of curves by a constant" \
proc = "%s %s values of curves by a constant" \
%(tempDict[cmd], yc)
cmdHelp[cmd] = [proc, usg]
tempDict = dict(zip(cmfeOps, cmfeOpsLongName))
for cmd in cmfeOps:
usg = "Usage: %s <curve-list>" %cmd
proc = "Procedure: Take %s of curves" % tempDict[cmd]
proc = "Take %s of curves" % tempDict[cmd]
cmdHelp[cmd] = [proc, usg]
def AddToggleOps():
......@@ -114,7 +114,7 @@ def AddRangeOps():
"""
for cmd in rangePlotOps:
usg = "Usage: %s <low-lim> <high-lim> or %s de "%(cmd, cmd)
proc = "Procedure: Set the %s for plotting"%cmd
proc = "Set the %s for plotting"%cmd
cmdHelp[cmd] = [proc, usg]
def CreateHelp():
......@@ -128,30 +128,34 @@ def CreateHelp():
cmdHelp["cp"] = ["",""]
cmdHelp["cc"] = ["",""]
#individual commands
cmdHelp["select"] = ["Procedure: Select curves from the menu for plotting"\
cmdHelp["select"] = ["Select curves from the menu for plotting"\
,"Usage: select <list-of-menu-numbers>"]
cmdHelp["menu"] = ["Macro: List the available curves", \
cmdHelp["menu"] = ["List the available curves", \
"Usage: menu"]
cmdHelp["lst"] = ["Macro: Display curves in list",\
cmdHelp["lst"] = ["Display curves in list",\
"Usage: lst"]
cmdHelp["erase"] = ["Macro: Erases all curves on the screen",\
cmdHelp["erase"] = ["Erases all curves on the screen",\
"Usage: erase"]
cmdHelp["del"] = ["Procedure: Delete curves from list", \
cmdHelp["del"] = ["Delete curves from list", \
"Usage: del <curve-list>"]
cmdHelp["end"] = ["Procedure: Exit ULTRA command wrapper", \
cmdHelp["end"] = ["Exit ULTRA command wrapper", \
"Usage: end"]
cmdHelp["quit"] = ["Procedure: Exit ULTRA command wrapper", \
cmdHelp["quit"] = ["Exit ULTRA command wrapper", \
"Usage: quit"]
cmdHelp["rd"] = ["Macro: Read curve data file", \
cmdHelp["rd"] = ["Read curve data file", \
"Usage: rd <\"file-name\">"]
cmdHelp["lnstyle"] = ["Procedure: Set the line styles of curves", \
cmdHelp["lnstyle"] = ["Set the line styles of curves", \
"Usage: lnstyle <curve-list> solid | dotted | dashed |dotdashed"]
cmdHelp["lnwidth"] = ["Procedure: Set the line widths of curves", \
cmdHelp["lnwidth"] = ["Set the line widths of curves", \
"Usage: lnstyle <curve-list> <width-number>"]
cmdHelp["save"] = ["Macro: Save curves to file", \
"Usage: save [<type>] <\"file-name\"> <curve-list>"]
cmdHelp["wrt"] = ["Macro: Save curves to file", \
"Usage: wrt [<type>] <\"file-name\"> <curve-list>"]
cmdHelp["save"] = ["Save curves to file", \
"Usage: save <\"file-name\"> <curve-list>"]
#cmdHelp["save"] = ["Save curves to file", \
# "Usage: save [<type>] <\"file-name\"> <curve-list>"]
cmdHelp["wrt"] = ["Save curves to file", \
"Usage: wrt <\"file-name\"> <curve-list>"]
#cmdHelp["wrt"] = ["Save curves to file", \
# "Usage: wrt [<type>] <\"file-name\"> <curve-list>"]
AddMathOps()
AddToggleOps()
AddRangeOps()
......@@ -292,9 +296,13 @@ plotOp = (oneOf(togglePlotOps).setResultsName("cmd") + \
#save
saveCmd = oneOf(saveOps).setResultsName("cmd") + \
Optional(oneOf("""ascii pdb""")).setResultsName("type") + \
fileName.setResultsName("file") + \
curveListAlpha.setResultsName("clist")
# save with optional type -- not currently supported
#saveCmd = oneOf(saveOps).setResultsName("cmd") + \
# Optional(oneOf("""ascii pdb""")).setResultsName("type") + \
# fileName.setResultsName("file") + \
# curveListAlpha.setResultsName("clist")
helpCmd = oneOf("""help""").setResultsName("cmd") + \
Optional(oneOf(cmdHelp.keys())).setResultsName("arg")
......
......@@ -514,9 +514,10 @@ def ultra_plotControl(t):
#-----------------------------------------------------------------------------
def ultra_saveCurve(t):
stype = "ascii"
if t.type:
stype = t.type
# type not currently supported, always saves as ascii
#stype = "ascii"
#if t.type:
# stype = t.type
if len(selectedList.curves) == 0:
return
cl = selectedList.slice(t.clist)
......@@ -528,9 +529,9 @@ def ultra_saveCurve(t):
currentPlot = setAsActivePlot(curve.plotId)
if (currentPlot != -1):
# This is how we need to do it for VisIt 2.0
#s = GetPlotInformation()['Curve']
s = GetPlotInformation()['Curve']
# This is how we need to do it for VisIt 1.12
s = GetOutputArray()
#s = GetOutputArray()
FILE.write("# %s\n"%curve.var)
for i in range(0, len(s), 2):
FILE.write("%13.6e %13.6e\n"%(s[i], s[i+1]))
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment