Commit 73ed5a0c authored by brugger's avatar brugger
Browse files

I made some more corrections to the python documentation.



git-svn-id: http://visit.ilight.com/svn/visit/trunk/src@27650 18c085ea-50e0-402c-830e-de6fd14e8384
parent 02b283d7
......@@ -2701,16 +2701,24 @@ const char *visit_GetEngineList_doc =
"Synopsis:\n"
"\n"
"GetEngineList() -> tuple of strings\n"
"GetEngineList(int) -> tuple of tuples containing engine/sim string pairs\n"
"GetEngineList(flag) -> tuple of tuples of strings\n"
"\n"
"\n"
"Arguments:\n"
"\n"
"flag (optional)\n"
"If flag is a non-zero integer then the function returns a tuple of tuples\n"
"with information about simulations.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"GetEngineList returns a tuple of strings that contain the names of the\n"
"computers on which compute engines are running. If a non-zero integer argument\n"
"is passed then the function returns a tuple of tuples where each tuple is\n"
"of length 2. Element 0 contains the names of the computers where the engines\n"
"are running. Element 1 contains the name of the simulation being run.\n"
"computers on which compute engines are running. If flag is a non-zero\n"
"integer argument then the function returns a tuple of tuples where each\n"
"tuple is of length 2. Element 0 contains the names of the computers where\n"
"the engines are running. Element 1 contains the names of the simulations\n"
"being run.\n"
"\n"
"\n"
"Description:\n"
......@@ -2734,7 +2742,6 @@ const char *visit_GetEngineList_doc =
"\n"
"for name in GetEngineList():\n"
"print \"VisIt has a compute engine running on %s\" % name\n"
"\n"
"CloseComputeEngine(GetEngineList()[1])\n"
;
......@@ -2750,17 +2757,26 @@ const char *visit_GetEngineProperties_doc =
"GetEngineProperties(engine, sim) -> EngineProperties\n"
"\n"
"\n"
"Returns: EngineProperties\n"
"Arguments:\n"
"\n"
"engine (optional)\n"
"When engine is passed and it matches one of the computer names returned\n"
"from GetEngineList() then the EngineProperties object for that engine is\n"
"returned.\n"
"sim (optional)\n"
"When both engine and sim arguments are passed, then the EngineProperties\n"
"object for the simulation is returned.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"The EngineProperties object for the specified compute engine/sim.\n"
"\n"
"\n"
"Description:\n"
"\n"
"GetEngineProperties returns an EngineProperties object containing the properties\n"
"for the specified compute engine/sim. There are multiple optional arguments.\n"
"When no arguments are passed, the default EngineProperties object is returned.\n"
"When the engine argument is passed and it matches one of the computer names \n"
"returned from GetEngineList() then the EngineProperties object for that engine\n"
"is returned. When both engine and sim arguments are passed, the EngineProperties\n"
"object for the simulation is returned. The EngineProperties let you discover \n"
"for the specified compute engine/sim. The EngineProperties let you discover\n"
"information such as number of processors, etc for a compute engine/sim.\n"
"\n"
"\n"
......@@ -4315,30 +4331,39 @@ const char *visit_NodePick_doc =
"\n"
"NodePick(namedarg1=arg1, namedarg2=arg2, ...) -> dictionary\n"
"\n"
"Required arguments:\n"
" coord (tuple of doubles): Spatial coordinate (x, y, z).\n"
" OR\n"
" x (integer): A screen X location (in pixels) offset from the left side\n"
" of the visualization window.\n"
" y (integer): A screen Y location (in pixels) offset from the bottom\n"
" of the visualization window.\n"
"\n"
"Optional named args:\n"
" vars (tuple of strings): variable names for which to return results.\n"
" (default: currently plotted variable)\n"
"\n"
"Time related arguments(optional):\n"
" do_time (integer): 1 -> do a time pick, 0 (default) -> do not do a time pick\n"
" start_time (integer): Starting frame index (default: 0)\n"
" end_time (integer): Ending frame index (default: num_timestates - 1)\n"
" stride (integer): Stride for advancing in time (default: 1)\n"
" preserve_coord (integer): 0 -> used picked element (default), 1-> used picked coordinate\n"
" curve_plot_type (integer): 0 -> single Y axis (default), 1 -> multiple Y Axes\n"
"\n"
"\n"
"Returns:\n"
"Arguments:\n"
"\n"
"PickByNode returns a python dictionary of the pick results, unless do_time is specified,\n"
"coord\n"
"A tuple of doubles containing the spatial coordinate (x, y, z).\n"
"x\n"
"An integer containing the screen X location (in pixels) offset from the\n"
"left side of the visualization window.\n"
"y\n"
"An integer containing the screen Y location (in pixels) offset from the\n"
"bottom of the visualization window.\n"
"vars (optional)\n"
"A tuple of strings with the variable names for which to return results.\n"
"(default: currently plotted variable)\n"
"do_time (optional)\n"
"An integer indicating whether to do a time pick. 1 -> do a time pick,\n"
"0 (default) -> do not do a time pick.\n"
"start_time (optional)\n"
"An integer with the starting frame index (default: 0).\n"
"end_time (optional)\n"
"An integer with the ending frame index (default: num_timestates - 1).\n"
"stride (optional)\n"
"An integer with the stride for advancing in time (default: 1).\n"
"preserve_coord (optional)\n"
"An integer indicating whether to pick an element or a coordinate. 0 ->\n"
"used picked element (default), 1-> used picked coordinate.\n"
"curve_plot_type (optional)\n"
"An integer indicating whether the output should be on a single axis or\n"
"with multiple axes. 0 -> single Y axis (default), 1 -> multiple Y Axes.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"NodePick returns a python dictionary of the pick results, unless do_time is specified,\n"
"then a time curve is created in a new window.\n"
"\n"
"\n"
......@@ -4722,30 +4747,39 @@ const char *visit_ZonePick_doc =
"\n"
"ZonePick(namedarg1=arg1, namedarg2=arg2, ...) -> dictionary\n"
"\n"
"Required arguments:\n"
" coord (tuple of doubles): Spatial coordinate (x, y, z).\n"
" OR\n"
" x (integer): A screen X location (in pixels) offset from the left side\n"
" of the visualization window.\n"
" y (integer): A screen Y location (in pixels) offset from the bottom\n"
" of the visualization window.\n"
"\n"
"Optional named args:\n"
" vars (tuple of strings): variable names for which to return results.\n"
" (default: currently plotted variable)\n"
"\n"
"Time related arguments(optional):\n"
" do_time (integer): 1 -> do a time pick, 0 (default) -> do not do a time pick\n"
" start_time (integer): Starting frame index (default: 0)\n"
" end_time (integer): Ending frame index (default: num_timestates - 1)\n"
" stride (integer): Stride for advancing in time (default: 1)\n"
" preserve_coord (integer): 0 -> used picked element (default), 1-> used picked coordinate\n"
" curve_plot_type (integer): 0 -> single Y axis (default), 1 -> multiple Y Axes\n"
"\n"
"\n"
"Returns:\n"
"Arguments:\n"
"\n"
"PickByZone returns a python dictionary of the pick results, unless do_time is specified,\n"
"coord\n"
"A tuple of doubles containing the spatial coordinate (x, y, z).\n"
"x\n"
"An integer containing the screen X location (in pixels) offset from the\n"
"left side of the visualization window.\n"
"y\n"
"An integer containing the screen Y location (in pixels) offset from the\n"
"bottom of the visualization window.\n"
"vars (optional)\n"
"A tuple of strings with the variable names for which to return results.\n"
"(default: currently plotted variable)\n"
"do_time (optional)\n"
"An integer indicating whether to do a time pick. 1 -> do a time pick,\n"
"0 (default) -> do not do a time pick.\n"
"start_time (optional)\n"
"An integer with the starting frame index (default: 0).\n"
"end_time (optional)\n"
"An integer with the ending frame index (default: num_timestates - 1).\n"
"stride (optional)\n"
"An integer with the stride for advancing in time (default: 1).\n"
"preserve_coord (optional)\n"
"An integer indicating whether to pick an element or a coordinate. 0 ->\n"
"used picked element (default), 1-> used picked coordinate.\n"
"curve_plot_type (optional)\n"
"An integer indicating whether the output should be on a single axis or\n"
"with multiple axes. 0 -> single Y axis (default), 1 -> multiple Y Axes.\n"
"\n"
"\n"
"Returns:\n"
"\n"
"ZonePick returns a python dictionary of the pick results, unless do_time is specified,\n"
"then a time curve is created in a new window.\n"
"If the picked variable is node centered, the variable values are grouped according to\n"
"incident node ids.\n"
......@@ -4780,23 +4814,30 @@ const char *visit_PickByGlobalNode_doc =
"\n"
"Synopsis:\n"
"\n"
"PickByGlobalNode(namedarg1=arg1, ...)\n"
"PickByGlobalNode(namedarg1=arg1, namedarg2=arg2, ...) -> dictionary\n"
"\n"
"Required named arguments:\n"
" element (integer): Global node id.\n"
"\n"
"Optional named arguments:\n"
" vars (tuple of strings): variable names\n"
" (default if not specified is currently plotted variabled)\n"
"\n"
"Time related arguments(optional):\n"
"Arguments:\n"
"\n"
" do_time (integer): 1 -> do a time pick, 0 (default) -> do not do a time pick\n"
" start_time (integer): Starting frame index (default: 0)\n"
" end_time (integer): Ending frame index (default: num_timestates - 1)\n"
" stride (integer): Stride for advancing in time (default: 1)\n"
" preserve_coord (integer): 0 -> used picked element (default), 1-> used picked coordinate\n"
" curve_plot_type (integer): 0 -> single Y axis (default), 1 -> multiple Y Axes\n"
"element\n"
"An integer with the global node id.\n"
"vars (optional)\n"
"A tuple of strings with the variable names for which to return results.\n"
"(default: currently plotted variable)\n"
"do_time (optional)\n"
"An integer indicating whether to do a time pick. 1 -> do a time pick,\n"
"0 (default) -> do not do a time pick.\n"
"start_time (optional)\n"
"An integer with the starting frame index (default: 0).\n"
"end_time (optional)\n"
"An integer with the ending frame index (default: num_timestates - 1).\n"
"stride (optional)\n"
"An integer with the stride for advancing in time (default: 1).\n"
"preserve_coord (optional)\n"
"An integer indicating whether to pick an element or a coordinate. 0 ->\n"
"used picked element (default), 1-> used picked coordinate.\n"
"curve_plot_type (optional)\n"
"An integer indicating whether the output should be on a single axis or\n"
"with multiple axes. 0 -> single Y axis (default), 1 -> multiple Y Axes.\n"
"\n"
"\n"
"Returns:\n"
......@@ -4838,23 +4879,30 @@ const char *visit_PickByGlobalZone_doc =
"\n"
"Synopsis:\n"
"\n"
"PickByGlobalZone(namedarg1=arg1, ...)\n"
"\n"
"Required named arguments:\n"
" element (integer): Global zone id.\n"
"\n"
"Optional named arguments:\n"
" vars (tuple of strings): variable names\n"
" (default if not specified is currently plotted variabled)\n"
"PickByGlobalZone(namedarg1=arg1, namedarg2=arg2, ...) -> dictionary\n"
"\n"
"Time related arguments(optional):\n"
"Arguments:\n"
"\n"
" do_time (integer): 1 -> do a time pick, 0 (default) -> do not do a time pick\n"
" start_time (integer): Starting frame index (default: 0)\n"
" end_time (integer): Ending frame index (default: num_timestates - 1)\n"
" stride (integer): Stride for advancing in time (default: 1)\n"
" preserve_coord (integer): 0 -> used picked element (default), 1-> used picked coordinate\n"
" curve_plot_type (integer): 0 -> single Y axis (default), 1 -> multiple Y Axes\n"
"element\n"
"An integer with the global zone id.\n"
"vars (optional)\n"
"A tuple of strings with the variable names for which to return results.\n"
"(default: currently plotted variable)\n"
"do_time (optional)\n"
"An integer indicating whether to do a time pick. 1 -> do a time pick,\n"
"0 (default) -> do not do a time pick.\n"
"start_time (optional)\n"
"An integer with the starting frame index (default: 0).\n"
"end_time (optional)\n"
"An integer with the ending frame index (default: num_timestates - 1).\n"
"stride (optional)\n"
"An integer with the stride for advancing in time (default: 1).\n"
"preserve_coord (optional)\n"
"An integer indicating whether to pick an element or a coordinate. 0 ->\n"
"used picked element (default), 1-> used picked coordinate.\n"
"curve_plot_type (optional)\n"
"An integer indicating whether the output should be on a single axis or\n"
"with multiple axes. 0 -> single Y axis (default), 1 -> multiple Y Axes.\n"
"\n"
"\n"
"Returns:\n"
......@@ -4896,21 +4944,30 @@ const char *visit_PickByNode_doc =
"\n"
"PickByNode(namedarg1=arg1, namedarg2=arg2, ...) -> dictionary\n"
"\n"
"Required arguments:\n"
" domain (integer): domain id\n"
" element (integer): node id\n"
"\n"
"Optional named args:\n"
" vars (tuple of strings): variable names for which to return results\n"
" (default: currently plotted variable)\n"
"Time related arguments(optional):\n"
"Arguments:\n"
"\n"
" do_time (integer): 1 -> do a time pick, 0 (default) -> do not do a time pick\n"
" start_time (integer): Starting frame index (default: 0)\n"
" end_time (integer): Ending frame index (default: num_timestates - 1)\n"
" stride (integer): Stride for advancing in time (default: 1)\n"
" preserve_coord (integer): 0 -> used picked element (default), 1-> used picked coordinate\n"
" curve_plot_type (integer): 0 -> single Y axis (default), 1 -> multiple Y Axes\n"
"domain\n"
"An integer with the domain id.\n"
"element\n"
"An integer with the node id.\n"
"vars (optional)\n"
"A tuple of strings with the variable names for which to return results.\n"
"(default: currently plotted variable)\n"
"do_time (optional)\n"
"An integer indicating whether to do a time pick. 1 -> do a time pick,\n"
"0 (default) -> do not do a time pick.\n"
"start_time (optional)\n"
"An integer with the starting frame index (default: 0).\n"
"end_time (optional)\n"
"An integer with the ending frame index (default: num_timestates - 1).\n"
"stride (optional)\n"
"An integer with the stride for advancing in time (default: 1).\n"
"preserve_coord (optional)\n"
"An integer indicating whether to pick an element or a coordinate. 0 ->\n"
"used picked element (default), 1-> used picked coordinate.\n"
"curve_plot_type (optional)\n"
"An integer indicating whether the output should be on a single axis or\n"
"with multiple axes. 0 -> single Y axis (default), 1 -> multiple Y Axes.\n"
"\n"
"\n"
"Returns:\n"
......@@ -4959,21 +5016,30 @@ const char *visit_PickByZone_doc =
"\n"
"PickByZone(namedarg1=arg1, namedarg2=arg2, ...) -> dictionary\n"
"\n"
"Required arguments:\n"
" domain (integer): domain id\n"
" element (integer): zone id\n"
"\n"
"Optional named args:\n"
" vars (tuple of strings): variable names for which to return results.\n"
" (default: currently plotted variable)\n"
"Arguments:\n"
"\n"
"Time related arguments(optional):\n"
" do_time (integer): 1 -> do a time pick, 0 (default) -> do not do a time pick\n"
" start_time (integer): Starting frame index (default: 0)\n"
" end_time (integer): Ending frame index (default: num_timestates - 1)\n"
" stride (integer): Stride for advancing in time (default: 1)\n"
" preserve_coord (integer): 0 -> used picked element (default), 1-> used picked coordinate\n"
" curve_plot_type (integer): 0 -> single Y axis (default), 1 -> multiple Y Axes\n"
"domain\n"
"An integer with the domain id.\n"
"element\n"
"An integer with the zone id.\n"
"vars (optional)\n"
"A tuple of strings with the variable names for which to return results.\n"
"(default: currently plotted variable)\n"
"do_time (optional)\n"
"An integer indicating whether to do a time pick. 1 -> do a time pick,\n"
"0 (default) -> do not do a time pick.\n"
"start_time (optional)\n"
"An integer with the starting frame index (default: 0).\n"
"end_time (optional)\n"
"An integer with the ending frame index (default: num_timestates - 1).\n"
"stride (optional)\n"
"An integer with the stride for advancing in time (default: 1).\n"
"preserve_coord (optional)\n"
"An integer indicating whether to pick an element or a coordinate. 0 ->\n"
"used picked element (default), 1-> used picked coordinate.\n"
"curve_plot_type (optional)\n"
"An integer indicating whether the output should be on a single axis or\n"
"with multiple axes. 0 -> single Y axis (default), 1 -> multiple Y Axes.\n"
"\n"
"\n"
"Returns:\n"
......@@ -7354,8 +7420,8 @@ const char *visit_SetPrecisionType_doc =
"\n"
"\n"
"Synopsis:\n"
"SetPrecisionType(typeAsInt)"
"SetPrecisionType(typeAsString)"
"SetPrecisionType(typeAsInt)\n"
"SetPrecisionType(typeAsString)\n"
"\n"
"\n"
"Arguments:\n"
......
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