IMPORT - Revision history

Jpye: /* What happens inside IMPORT */

2016-07-26T12:20:54Z

What happens inside IMPORT

← Older revision		Revision as of 12:20, 26 July 2016
Line 10:		Line 10:
	* Second, valid importable files are looked for in the path specified in the <tt>[[Environment variables for ASCEND#ASCENDLIBRARY\|ASCENDLIBRARY]]</tt> environment variable.		* Second, valid importable files are looked for in the path specified in the <tt>[[Environment variables for ASCEND#ASCENDLIBRARY\|ASCENDLIBRARY]]</tt> environment variable.

	'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>ascend_solver1.dll</tt>' (Windows) or '<tt>ascend_solver1.so</tt>' (Linux) to be loaded using the statement '<tt>IMPORT "~~solver~~"</tt>', or '<tt>solver2.py</tt>' ~~to be loaded~~ using the statement '<tt>solver2~~.py~~</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts~~, which~~ at present can only be used to provide [[External Methods]] functionality.		'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>ascend_solver1.dll</tt>' (Windows) or '<tt>ascend_solver1.so</tt>' (Linux) to be loaded using the statement '<tt>IMPORT "solver1"</tt>', or alternatively you can load the Python code '<tt>solver2.py</tt>' using the statement '<tt>IMPORT "solver2"</tt>' (but read about [[ExtPy]] to understand more about this option). The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts. [[ExtPy]] at present can only be used to provide [[External Methods]] functionality.

	This allows your model file to be cross-platform as well as agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as 'ascend_mystuff.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller.		This allows your model file to be cross-platform as well as agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as 'ascend_mystuff.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller, which is why the file extensions are left off.

	See [[Environment variables for ASCEND]] for more information.		See [[Environment variables for ASCEND]] for more information.

Jpye: /* What happens inside IMPORT */

2012-04-23T23:10:51Z

What happens inside IMPORT

← Older revision		Revision as of 23:10, 23 April 2012
Line 10:		Line 10:
	* Second, valid importable files are looked for in the path specified in the <tt>[[Environment variables for ASCEND#ASCENDLIBRARY\|ASCENDLIBRARY]]</tt> environment variable.		* Second, valid importable files are looked for in the path specified in the <tt>[[Environment variables for ASCEND#ASCENDLIBRARY\|ASCENDLIBRARY]]</tt> environment variable.

	'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>~~libsolver1~~.so</tt>' to be loaded using the ~~name~~ '<tt>~~solver1~~</tt>', or '<tt>solver2.py</tt>' to be loaded using the ~~name~~ '<tt>solver2</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.		'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>ascend_solver1.dll</tt>' (Windows) or '<tt>ascend_solver1.so</tt>' (Linux) to be loaded using the statement '<tt>IMPORT "solver"</tt>', or '<tt>solver2.py</tt>' to be loaded using the statement '<tt>solver2.py</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.

	This allows your model file to be agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as '~~mystuff~~.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller.		This allows your model file to be cross-platform as well as agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as 'ascend_mystuff.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller.

	See [[Environment variables for ASCEND]] for more information.		See [[Environment variables for ASCEND]] for more information.

Jpye: /* What happens inside IMPORT */

2012-04-23T22:59:13Z

What happens inside IMPORT

← Older revision		Revision as of 22:59, 23 April 2012
Line 7:		Line 7:
	== What happens inside <tt>IMPORT</tt> ==		== What happens inside <tt>IMPORT</tt> ==

	* First, valid importable files are looked for in the path specified in the <tt>[[~~Environment_variables_for_ASCEND~~\|ASCENDSOLVERS]]</tt> environment variable. If found, the importable file is loaded and the status of the load attempt is returned to the user.		* First, valid importable files are looked for in the path specified in the <tt>[[Environment variables for ASCEND\|ASCENDSOLVERS]]</tt> environment variable. If found, the importable file is loaded and the status of the load attempt is returned to the user.
	* Second, valid importable files are looked for in the path specified in the <tt>ASCENDLIBRARY</tt> environment variable.		* Second, valid importable files are looked for in the path specified in the <tt>[[Environment variables for ASCEND#ASCENDLIBRARY\|ASCENDLIBRARY]]</tt> environment variable.

	'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>libsolver1.so</tt>' to be loaded using the name '<tt>solver1</tt>', or '<tt>solver2.py</tt>' to be loaded using the name '<tt>solver2</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.		'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>libsolver1.so</tt>' to be loaded using the name '<tt>solver1</tt>', or '<tt>solver2.py</tt>' to be loaded using the name '<tt>solver2</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.

Jpye at 03:04, 19 May 2010

2010-05-19T03:04:50Z

← Older revision		Revision as of 03:04, 19 May 2010
Line 1:		Line 1:
	The <tt>IMPORT</tt> statement in ASCEND model files is used to load external code that gives ASCEND new functionality. This includes loading [[external methods]], [[external relations]] and [[external solvers]] (including [[Integrators]]), and even external [[import handlers]], which allows you to provide the means to hook up new languages for the provision of any of these services.		The <tt>IMPORT</tt> statement in ASCEND model files is used to load external code that gives ASCEND new functionality. This includes loading [[external methods]], [[external relations]] and [[external solvers]] (including [[Integrators]]), and even external [[import handlers]], which allows you to provide the means to hook up new languages for the provision of any of these services.


	For examples of what can be done with the <tt>IMPORT</tt> statement, see [[External Libraries]].		For examples of what can be done with the <tt>IMPORT</tt> statement, see [[External Libraries]].

	See also [[REQUIRE]], which is used to import other ASCEND models (as opposed to external non-ASCEND code).		See also [[REQUIRE]], which is used to import other ASCEND models (as opposed to external non-ASCEND code).


	== What happens inside <tt>IMPORT</tt> ==		== What happens inside <tt>IMPORT</tt> ==
Line 13:		Line 11:

	'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>libsolver1.so</tt>' to be loaded using the name '<tt>solver1</tt>', or '<tt>solver2.py</tt>' to be loaded using the name '<tt>solver2</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.		'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>libsolver1.so</tt>' to be loaded using the name '<tt>solver1</tt>', or '<tt>solver2.py</tt>' to be loaded using the name '<tt>solver2</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.


	This allows your model file to be agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as 'mystuff.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller.		This allows your model file to be agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as 'mystuff.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller.

	See [[Environment variables for ASCEND]] for more information.		See [[Environment variables for ASCEND]] for more information.


	== Default values for <tt>ASCENDSOLVERS</tt> and <tt>ASCENDLIBRARY</tt> ==		== Default values for <tt>ASCENDSOLVERS</tt> and <tt>ASCENDLIBRARY</tt> ==
Line 25:		Line 21:

	Also the possibility of using the .ascend.ini file. Need to check/document this.		Also the possibility of using the .ascend.ini file. Need to check/document this.



	== Process, in more detail ==		== Process, in more detail ==
Line 33:		Line 27:

	The process used is like this:		The process used is like this:


	* ASCEND finds a statement like <tt>IMPORT "mything"</tt>		* ASCEND finds a statement like <tt>IMPORT "mything"</tt>
Line 44:		Line 37:

	By default, there is only one Import Handler defined, called ExtFn. This import handler provides the ability to import external shared libraries. It handles the platform-specific naming conventions and the <tt>dlopen</tt> calls. You can use the ExtFn import handler to load other import handler for your specific task.		By default, there is only one Import Handler defined, called ExtFn. This import handler provides the ability to import external shared libraries. It handles the platform-specific naming conventions and the <tt>dlopen</tt> calls. You can use the ExtFn import handler to load other import handler for your specific task.


	See also [[ExtPy]] which is an import handler for python scripts.		See also [[ExtPy]] which is an import handler for python scripts.

			[[Category:Extending_ASCEND]]


	[[Category:Extending_ASCEND]]
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Syntax]]		[[Category:Syntax]]

Jpye at 03:02, 19 May 2010

2010-05-19T03:02:12Z

← Older revision		Revision as of 03:02, 19 May 2010
Line 1:		Line 1:
	The <tt>IMPORT</tt> statement in ASCEND model files is used to load external code that gives ASCEND new functionality. This includes loading [[~~External Methods~~]], [[~~External Functions~~]] and [[~~External Solvers~~]] (including Integrators), and even external [[~~Import Handlers~~]], which allows you to provide the means to hook up new languages for the provision of any of these services.		The <tt>IMPORT</tt> statement in ASCEND model files is used to load external code that gives ASCEND new functionality. This includes loading [[external methods]], [[external relations]] and [[external solvers]] (including [[Integrators]]), and even external [[import handlers]], which allows you to provide the means to hook up new languages for the provision of any of these services.

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

2010-05-13T13:38:39Z

Restored page from Google Cache, uploaded by John Pye

New page

The <tt>IMPORT</tt> statement in ASCEND model files is used to load external code that gives ASCEND new functionality. This includes loading [[External Methods]], [[External Functions]] and [[External Solvers]] (including Integrators), and even external [[Import Handlers]], which allows you to provide the means to hook up new languages for the provision of any of these services.

For examples of what can be done with the <tt>IMPORT</tt> statement, see [[External Libraries]].

See also [[REQUIRE]], which is used to import other ASCEND models (as opposed to external non-ASCEND code).

== What happens inside <tt>IMPORT</tt> ==

* First, valid importable files are looked for in the path specified in the <tt>[[Environment_variables_for_ASCEND|ASCENDSOLVERS]]</tt> environment variable. If found, the importable file is loaded and the status of the load attempt is returned to the user.
* Second, valid importable files are looked for in the path specified in the <tt>ASCENDLIBRARY</tt> environment variable.

'Importable files' are those with filenames that match the patterns specified by available Import Handlers. Import handlers allows files like '<tt>libsolver1.so</tt>' to be loaded using the name '<tt>solver1</tt>', or '<tt>solver2.py</tt>' to be loaded using the name '<tt>solver2</tt>'. The current import handlers provided are 'extlib' for loading shared libaries (.so or .dll files), and [[ExtPy]] for loading external python scripts, which at present can only be used to provide [[External Methods]] functionality.

This allows your model file to be agnostic about the way that external functionality is defined. If it is defined as 'mystuff.py' or as 'mystuff.so', you still use the same 'IMPORT "mystuff"' statement. We wanted to hide the implementation details from the modeller.

See [[Environment variables for ASCEND]] for more information.

== Default values for <tt>ASCENDSOLVERS</tt> and <tt>ASCENDLIBRARY</tt> ==

These variables are optional. If not specified in your environment, default values are used.

Also the possibility of using the .ascend.ini file. Need to check/document this.

== Process, in more detail ==

Whenever ASCEND sees an <tt>IMPORT</tt> statement it uses an Import Handler to process it. ASCEND keeps a list of Import Handlers, and the first one that finds something it can import is given the job.

The process used is like this:

* ASCEND finds a statement like <tt>IMPORT "mything"</tt>
* It looks at the first Import Handler on its list
* It requests the Import Handler to translate the string <tt>mything</tt> into a filename corresponding to that particular handler
* ASCEND looks to see if the named file exists anywhere in the ASCENDLIBRARY path
* It moves through the list of Import Handlers until a file is found in the search path that matches the filename returned by the Import Handler
* ASCEND then calls the 'import' function for that particular Import Handler, passing it the full pathname of the file to be imported.
* The 'import' function can do whatever it likes. It could load a new solver, add external methods or blackbox functions, launch another program, etc. Any functionality exposed via the libascend.so API is accessible.

By default, there is only one Import Handler defined, called ExtFn. This import handler provides the ability to import external shared libraries. It handles the platform-specific naming conventions and the <tt>dlopen</tt> calls. You can use the ExtFn import handler to load other import handler for your specific task.

See also [[ExtPy]] which is an import handler for python scripts.

[[Category:Extending_ASCEND]]
[[Category:Documentation]]
[[Category:Syntax]]