Scripting ASCEND using Python - Revision history

Jpye: /* A more robust example */

2026-02-07T22:59:26Z

A more robust example

← Older revision		Revision as of 22:59, 7 February 2026
Line 67:		Line 67:
	This example solves a model for a few different values of one particular variable, and then plots the results using Matplotlib.		This example solves a model for a few different values of one particular variable, and then plots the results using Matplotlib.

	<source lang=py>		<source lang=python>
	#!/usr/bin/env python		#!/usr/bin/env python
	"""		"""

Jpye: /* Example of a standalone Python script with ASCEND */

2026-02-07T22:59:15Z

Example of a standalone Python script with ASCEND

← Older revision		Revision as of 22:59, 7 February 2026
Line 34:		Line 34:
	This script can be run using the command		This script can be run using the command

	<source lang="sh">PYTHONPATH=~/ascend/pygtk python example.py</source>		<source lang="shellscript">PYTHONPATH=~/ascend/pygtk python example.py</source>

	As well as large amounts of debug output, this also finally outputs:		As well as large amounts of debug output, this also finally outputs:

Jpye at 22:58, 7 February 2026

2026-02-07T22:58:48Z

← Older revision		Revision as of 22:58, 7 February 2026
Line 16:		Line 16:
	Here is an example of a simple script that loads a model (namely {{src\|models/johnpye/testlog10.a4c}}) and solves it, then runs the 'self_test' method on the model, then prints out the value of a variable from the model.		Here is an example of a simple script that loads a model (namely {{src\|models/johnpye/testlog10.a4c}}) and solves it, then runs the 'self_test' method on the model, then prints out the value of a variable from the model.

	<source lang="py">#!/usr/bin/env python		<source lang="python">#!/usr/bin/env python
	# file 'example.py':		# file 'example.py':

Jpye: /* A more robust example */

2011-02-24T05:46:38Z

A more robust example

← Older revision		Revision as of 05:46, 24 February 2011
Line 67:		Line 67:
	This example solves a model for a few different values of one particular variable, and then plots the results using Matplotlib.		This example solves a model for a few different values of one particular variable, and then plots the results using Matplotlib.

	<source lang=~~a4c~~>		<source lang=py>
	#!/usr/bin/env python		#!/usr/bin/env python
	"""		"""

Jpye at 05:46, 24 February 2011

2011-02-24T05:46:27Z

@@ Line 60: / Line 60: @@
 See [[ExtPy]].
 [[Category:Documentation]]
 [[Category:Examples]]

Jpye at 00:26, 8 November 2010

2010-11-08T00:26:47Z

← Older revision		Revision as of 00:26, 8 November 2010
Line 22:		Line 22:
	L = ascpy.Library()		L = ascpy.Library()

	L.load(~~"~~johnpye/testlog10.a4c~~"~~)		L.load("johnpye/testlog10.a4c")

	T = L.findType(~~"~~testlog10~~"~~)		T = L.findType("testlog10")
	M = T.getSimulation('sim')		M = T.getSimulation('sim')

	M.solve(ascpy.Solver(~~"~~QRSlv~~"~~),ascpy.SolverReporter())		M.solve(ascpy.Solver("QRSlv"),ascpy.SolverReporter())
	M.run(T.getMethod('self_test'))		M.run(T.getMethod('self_test'))

	print ~~"~~After solving, z =~~"~~,float(M.z)</source>		print "After solving, z =",float(M.z)</source>

	This script can be run using the command		This script can be run using the command
Line 61:		Line 61:
	See [[ExtPy]].		See [[ExtPy]].

			[[Category:Documentation]]


	[[Category:Documentation]]
	[[Category:Examples]]		[[Category:Examples]]

Jpye: /* Example of a standalone Python script with ASCEND */

2010-06-01T03:49:14Z

Example of a standalone Python script with ASCEND

← Older revision		Revision as of 03:49, 1 June 2010
Line 36:		Line 36:
	<source lang="sh">PYTHONPATH=~/ascend/pygtk python example.py</source>		<source lang="sh">PYTHONPATH=~/ascend/pygtk python example.py</source>

	As well as ~~stacks~~ of debug output, this also finally outputs:		As well as large amounts of debug output, this also finally outputs:

	<pre>		<pre>

WikiSysop at 02:58, 17 May 2010

2010-05-17T02:58:36Z

← Older revision		Revision as of 02:58, 17 May 2010
Line 9:		Line 9:

	There are two different ways of accessing the Python API for ASCEND. The first way is the more natural one, which is to simply write a standalone Python script that '''wraps''' the ASCEND engine and makes it do things. The second way is via the [[ExtPy]] mechanism, which lets you write fragments of Python that can be run '''embedded''' within the [[METHODS]] interface in the PyGTK GUI. The first is better for quick hacks, the second is better for providing reusable functionality, although it still represents code at a somewhat experimental stage.		There are two different ways of accessing the Python API for ASCEND. The first way is the more natural one, which is to simply write a standalone Python script that '''wraps''' the ASCEND engine and makes it do things. The second way is via the [[ExtPy]] mechanism, which lets you write fragments of Python that can be run '''embedded''' within the [[METHODS]] interface in the PyGTK GUI. The first is better for quick hacks, the second is better for providing reusable functionality, although it still represents code at a somewhat experimental stage.


	Currently, the best place to find examples of what can be done with the ASCEND Python API is in the code of the file {{src\|test.py}} from the code repository. There is not yet any good documentation for the Python API, unfortunately.		Currently, the best place to find examples of what can be done with the ASCEND Python API is in the code of the file {{src\|test.py}} from the code repository. There is not yet any good documentation for the Python API, unfortunately.


	== Example of a standalone Python script with ASCEND ==		== Example of a standalone Python script with ASCEND ==

WikiSysop: /* Example of a standalone Python script with ASCEND */

2010-05-17T02:58:24Z

Example of a standalone Python script with ASCEND

← Older revision		Revision as of 02:58, 17 May 2010
Line 35:		Line 35:

	This script can be run using the command		This script can be run using the command


	<source lang="sh">PYTHONPATH=~/ascend/pygtk python example.py</source>		<source lang="sh">PYTHONPATH=~/ascend/pygtk python example.py</source>

WikiSysop: /* Example of a standalone Python script with ASCEND */

2010-05-17T02:58:10Z

Example of a standalone Python script with ASCEND

← Older revision		Revision as of 02:58, 17 May 2010
Line 18:		Line 18:
	Here is an example of a simple script that loads a model (namely {{src\|models/johnpye/testlog10.a4c}}) and solves it, then runs the 'self_test' method on the model, then prints out the value of a variable from the model.		Here is an example of a simple script that loads a model (namely {{src\|models/johnpye/testlog10.a4c}}) and solves it, then runs the 'self_test' method on the model, then prints out the value of a variable from the model.

	<source lang="~~a4c~~">#!/usr/bin/env python		<source lang="py">#!/usr/bin/env python
	# file 'example.py':		# file 'example.py':

Line 37:		Line 37:


	<source lang="~~a4c~~">PYTHONPATH=~/ascend/pygtk python example.py</source>		<source lang="sh">PYTHONPATH=~/ascend/pygtk python example.py</source>

	As well as stacks of debug output, this also finally outputs:		As well as stacks of debug output, this also finally outputs:
Line 59:		Line 59:

	With care, one can set up the model then repeatedly solve it for different variable values, etc.		With care, one can set up the model then repeatedly solve it for different variable values, etc.



	== Example of a script embedded within an ASCEND model ==		== Example of a script embedded within an ASCEND model ==