ExtPy - Revision history

Jpye: /* Notes */

2012-04-17T03:01:06Z

Notes

← Older revision		Revision as of 03:01, 17 April 2012
Line 23:		Line 23:
	== Notes ==		== Notes ==

	If you want to implement your own 'ExtPy' module, you should ~~not~~ the following basic structure:		If you want to implement your own 'ExtPy' module, you should note the following basic structure:

	<source lang="py">		<source lang="py">

Jpye at 07:51, 26 May 2010

2010-05-26T07:51:47Z

← Older revision		Revision as of 07:51, 26 May 2010
Line 1:		Line 1:
	~~<div class="pageexperimental">''This page documents an '''~~experimental~~''' feature. You can help out by '''testing it''' and <span class="plainlinks">[http://ascendwiki.cheme.cmu.edu/index.php?title=ExtPy&action=edit recording]</span> your experiences.''</div>~~		{{experimental}}

	ExtPy is a special ASCEND external library that adds an [[Import_handlers\|import handler]] that allows python scripts to be called from the <tt>METHODS</tt> section of your model. You can write any script you like inside your external python script, and launch it from the 'Methods' drop-down in the PyGTK GUI.		ExtPy is a special ASCEND external library that adds an [[Import_handlers\|import handler]] that allows python scripts to be called from the <tt>METHODS</tt> section of your model. You can write any script you like inside your external python script, and launch it from the 'Methods' drop-down in the PyGTK GUI.

	An example is {{src\|models/johnpye/fourbar.a4c}} which makes reference to {{src\|models/johnpye/fourbarplot.py}}		An example is {{src\|models/johnpye/fourbar.a4c}} which makes reference to {{src\|models/johnpye/fourbarplot.py}}


	== ExtPy modules ==		== ExtPy modules ==

	ExtPy modules have been written that		ExtPy modules have been written that


	* solve the model repeatedly and create a composite plot of the results		* solve the model repeatedly and create a composite plot of the results
Line 22:		Line 20:

	ExtPy methods can be used from the Tcl/Tk GUI, although obviously they can't make PyGTK GUI output in that case.		ExtPy methods can be used from the Tcl/Tk GUI, although obviously they can't make PyGTK GUI output in that case.


	== Notes ==		== Notes ==
Line 44:		Line 41:
	# this is where you define your external method		# this is where you define your external method
	def fourbarplot(self):		def fourbarplot(self):
	~~"""~~Document the method with a docstring; this text will appear in the ASCEND GUI~~"""~~		"""Document the method with a docstring; this text will appear in the ASCEND GUI"""

	# use the following if your method uses matplotlib; this will ensure		# use the following if your method uses matplotlib; this will ensure
Line 62:		Line 59:
	extpy.registermethod(fourbarplot)		extpy.registermethod(fourbarplot)

	# the above method can be called using ~~"~~EXTERNAL fourbarplot(SELF)~~"~~ in ASCEND.</source>		# the above method can be called using "EXTERNAL fourbarplot(SELF)" in ASCEND.</source>

	[[Category:Extending_ASCEND]]		[[Category:Extending_ASCEND]]

Jpye: /* Notes */

2010-05-26T07:51:10Z

Notes

← Older revision		Revision as of 07:51, 26 May 2010
Line 28:		Line 28:
	If you want to implement your own 'ExtPy' module, you should not the following basic structure:		If you want to implement your own 'ExtPy' module, you should not the following basic structure:

			<source lang="py">
	<source lang="~~a4c~~"># import the 'extpy' module for basic access to the ASCEND API		# import the 'extpy' module for basic access to the ASCEND API
	import extpy		import extpy

Line 64:		Line 64:
	# the above method can be called using "EXTERNAL fourbarplot(SELF)" in ASCEND.</source>		# the above method can be called using "EXTERNAL fourbarplot(SELF)" in ASCEND.</source>



	~~[[Category:Experimental]]~~
	[[Category:Extending_ASCEND]]		[[Category:Extending_ASCEND]]

UploadBot: Restored page from Google Cache, uploaded by John Pye

2010-05-13T13:54:24Z

Restored page from Google Cache, uploaded by John Pye

New page

<div class="pageexperimental">''This page documents an '''experimental''' feature. You can help out by '''testing it''' and <span class="plainlinks">[http://ascendwiki.cheme.cmu.edu/index.php?title=ExtPy&action=edit recording]</span> your experiences.''</div>

ExtPy is a special ASCEND external library that adds an [[Import_handlers|import handler]] that allows python scripts to be called from the <tt>METHODS</tt> section of your model. You can write any script you like inside your external python script, and launch it from the 'Methods' drop-down in the PyGTK GUI.

An example is {{src|models/johnpye/fourbar.a4c}} which makes reference to {{src|models/johnpye/fourbarplot.py}}

== ExtPy modules ==

ExtPy modules have been written that

* solve the model repeatedly and create a composite plot of the results
* produce specialised plots that could not be produced using the old 'plot.a4l' approach.
* perform stability analysis on the DAE system
* [[Solver_NOTES|set parameters in the solver]] based on the contents of <tt>NOTES</tt> in the model
* run the solver (useful during <tt>'on_load'</tt> methods on models where initialisation is a bit trickier.)
* perform [[Parametric studies]]
* create 3D visualisations using OpenGL (see [[Optimisation of frame geometry]])

An advantage of using ExtPy methods instead of writing an entire 'driver' script is that you method can be called from the PyGTK GUI and can be more easily reused from multiple model files.

ExtPy methods can be used from the Tcl/Tk GUI, although obviously they can't make PyGTK GUI output in that case.

== Notes ==

If you want to implement your own 'ExtPy' module, you should not the following basic structure:

<source lang="a4c"># import the 'extpy' module for basic access to the ASCEND API
import extpy

# any stuff that might cause errors should be imported like this:
try:
from pylab import *

except:
pass

# you can import standard ASCEND components, for example:
from solverreporter import *

# this is where you define your external method
def fourbarplot(self):
"""Document the method with a docstring; this text will appear in the ASCEND GUI"""

# use the following if your method uses matplotlib; this will ensure
# that visible error messages are thrown if matplotlib is not installed.

import loading
loading.load_matplotlib(throw=True)

# to gain access to the main PyGTK GUI window, use the following:
browser = extpy.getbrowser()

browser.do_solve()

# rest of your method here

# finally, tell ASCEND about the method you have just defined:
extpy.registermethod(fourbarplot)

# the above method can be called using "EXTERNAL fourbarplot(SELF)" in ASCEND.</source>

[[Category:Experimental]]
[[Category:Extending_ASCEND]]