Changeset 44:10d33af464cf

Timestamp:

10/05/09 13:31:04 (4 years ago)

Author:

Andrew Davison <andrew.davison@…>

Branch:

default

Message:

Minor documentation changes

Location:

doc

Files:

• build_reference.py (modified) (2 diffs)
• using_the_api.txt (modified) (4 diffs)
• using_the_api_example.py (modified) (2 diffs)

doc/build_reference.py

@@ -2 +2 @@
 from sumatra import commands
 
-modes = ("init", "configure", "info", "run", "list", "delete", "comment", "tag", "repeat")
+modes = ["init", "configure", "info", "run", "list", "delete", "comment", "tag", "repeat"]
 modes.sort()
 
@@ -26 +26 @@
 f.write("=====================\n\n")
 
-for mode, sio in usage.items():
+for mode in modes:
+    sio = usage[mode]
     f.write(mode + '\n')
     f.write('-'*len(mode) + '\n::\n\n    ')

doc/using_the_api.txt

@@ -64 +64 @@
 the parameters for later use in searching and comparison, so they need to be
 transformed into a form Sumatra can use. This is very simple, we just replace
-the ``execfile()`` call with a ``build_parameters()`` call.
+the ``execfile()`` call with a ``build_parameters()`` call::
 
     from sumatra.parameters import build_parameters
     parameters = build_parameters(parameter_file)
     
-Now we create a new ``SimRecord`` object, telling it which script and executable
-to use (these are obviously inferable, but in the current version of Sumatra
-we have to specify them explicitly)::
+Now we create a new ``SimRecord`` object, telling it that the script is the
+current file::
 
-    from sumatra.programs import Script, get_executable
-    simulator = get_executable('python')
+    from sumatra.programs import Script
     script = Script(main_file=__file__)
     script.update_code()
     
     sim_record = project.new_record(parameters=parameters,
-                                    executable=simulator,
                                     script=script,
                                     label="api_example",
@@ -85 +82 @@
 
 Now comes the main body of the simulation, which is unchanged except that we
-take the opportunity to give the output data file a more informative name:
+take the opportunity to give the output data file a more informative name::
 
     output_file = "%s.dat" % sim_record.label
@@ -106 +103 @@
     import time
     from sumatra.projects import load_simulation_project
-    from sumatra.programs import Script, get_executable
+    from sumatra.programs import Script
     from sumatra.parameters import build_parameters
 
@@ -115 +112 @@
     parameters = build_parameters(parameter_file)
 
-    simulator = get_executable('python')
     script = Script(main_file=__file__)
     script.update_code()
     
     sim_record = project.new_record(parameters=parameters,
-                                    executable=simulator,
                                     script=script,
                                     label="api_example",

doc/using_the_api_example.py

@@ -3 +3 @@
 import time
 from sumatra.projects import load_simulation_project
-from sumatra.programs import Script, get_executable
+from sumatra.programs import Script
 from sumatra.parameters import build_parameters
 
@@ -12 +12 @@
 parameters = build_parameters(parameter_file)
 
-simulator = get_executable('python')
 script = Script(main_file=__file__)
 script.update_code()
     
 sim_record = project.new_record(parameters=parameters,
-                                executable=simulator,
                                 script=script,
                                 label="api_example",