Environment variables for ASCEND - Revision history

Jpye at 23:05, 23 April 2012

2012-04-23T23:05:10Z

← Older revision		Revision as of 23:05, 23 April 2012
Line 3:		Line 3:
	The following environment variables affect how ASCEND runs. In most cases, if the default behaviour is not correct, the only ones you will need to set are [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]] (or PATH on Windows).		The following environment variables affect how ASCEND runs. In most cases, if the default behaviour is not correct, the only ones you will need to set are [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]] (or PATH on Windows).

	'''How to set environment variables''': On Linux and Mac, you can temporarily set environment variables from your terminal using the <tt>export</tt> command, or permanently by editing your <tt>.bashrc</tt> or <tt>.profile</tt> file (depends on your distribution). On Windows, see [http://www.~~itechtalk~~.com/~~thread3595~~.~~html~~ these instructions].		'''How to set environment variables''': On Linux and Mac, you can temporarily set environment variables from your terminal using the <tt>export</tt> command, or permanently by editing your <tt>.bashrc</tt> or <tt>.profile</tt> file (depends on your distribution). On Windows, see [http://www.windows7hacker.com/index.php/2010/05/how-to-addedit-environment-variables-in-windows-7/ these instructions].

	== ASCENDLIBRARY ==		== ASCENDLIBRARY ==

Jpye at 23:02, 23 April 2012

2012-04-23T23:02:34Z

← Older revision		Revision as of 23:02, 23 April 2012
Line 2:		Line 2:

	The following environment variables affect how ASCEND runs. In most cases, if the default behaviour is not correct, the only ones you will need to set are [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]] (or PATH on Windows).		The following environment variables affect how ASCEND runs. In most cases, if the default behaviour is not correct, the only ones you will need to set are [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]] (or PATH on Windows).

			'''How to set environment variables''': On Linux and Mac, you can temporarily set environment variables from your terminal using the <tt>export</tt> command, or permanently by editing your <tt>.bashrc</tt> or <tt>.profile</tt> file (depends on your distribution). On Windows, see [http://www.itechtalk.com/thread3595.html these instructions].

	== ASCENDLIBRARY ==		== ASCENDLIBRARY ==

Jpye at 21:45, 7 March 2011

2011-03-07T21:45:26Z

← Older revision		Revision as of 21:45, 7 March 2011
Line 1:		Line 1:
	{{stub}}		{{stub}}

	The following environment variables affect how ASCEND runs. In most cases, the only ~~one~~ you will need to set is [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly ~~PATH or~~ [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]].		The following environment variables affect how ASCEND runs. In most cases, if the default behaviour is not correct, the only ones you will need to set are [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]] (or PATH on Windows).

	== ASCENDLIBRARY ==		== ASCENDLIBRARY ==
Line 60:		Line 60:

	When using the [[IPOPT]] solver, it may also be necessary to use this env var to point to external solvers such as /usr/local/lib/libhsl.so.		When using the [[IPOPT]] solver, it may also be necessary to use this env var to point to external solvers such as /usr/local/lib/libhsl.so.

			On operating systems other than Linux, this environment variable has different names. On Windows, use 'PATH'; on Mac OS X, use 'DYLD_LIBRARY_PATH'.

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

Jpye at 21:43, 7 March 2011

2011-03-07T21:43:41Z

← Older revision		Revision as of 21:43, 7 March 2011
Line 1:		Line 1:
	~~<div class="notice metadata" id="~~stub">''This article is a '''stub'''. You can help out by <span class="plainlinks">[http://ascendwiki.cheme.cmu.edu/index.php?title=Environment_variables_for_ASCEND&action=edit expanding it]</span>. ''</div>		{{stub}}

	~~The following environment variables affect how ASCEND runs.~~



			The following environment variables affect how ASCEND runs. In most cases, the only one you will need to set is [[#ASCENDLIBRARY\|ASCENDLIBRARY]] and possibly PATH or [[#LD_LIBRARY_PATH\|LD_LIBRARY_PATH]].

	== ASCENDLIBRARY ==		== ASCENDLIBRARY ==
Line 13:		Line 10:

	When ASCEND loads, the following methods are used in order of decreasing priority:		When ASCEND loads, the following methods are used in order of decreasing priority:


	* the ASCENDLIBRARY environment variable, if present		* the ASCENDLIBRARY environment variable, if present
Line 22:		Line 18:

	The '''exception''' to this is that ''if'' the ASCENDLIBRARY variable is defined, but it ''does not'' contain the standard [[ASCEND Model Library]] folder (probably <tt>/usr/share/ascend/models</tt> or <tt>c:\Program Files\ASCEND\models</tt>), then it will be added to the '''end''' of the ASCENDLIBRARY path. This is to ensure that the model library will always be available for use with [[REQUIRE]] statements, and to make setting of non-standard paths a little more convenient.		The '''exception''' to this is that ''if'' the ASCENDLIBRARY variable is defined, but it ''does not'' contain the standard [[ASCEND Model Library]] folder (probably <tt>/usr/share/ascend/models</tt> or <tt>c:\Program Files\ASCEND\models</tt>), then it will be added to the '''end''' of the ASCENDLIBRARY path. This is to ensure that the model library will always be available for use with [[REQUIRE]] statements, and to make setting of non-standard paths a little more convenient.


	See also [[REQUIRE]], [[IMPORT]].		See also [[REQUIRE]], [[IMPORT]].


	== ASCENDSOLVERS ==		== ASCENDSOLVERS ==

	This variable is used in the <tt>package_load</tt> function that ASCEND uses in [[IMPORT]] statements, when loading external libraries, including solvers.		This variable is used in the <tt>package_load</tt> function that ASCEND uses in [[IMPORT]] statements, when loading external libraries, including solvers.


	ASCEND defines a value for ASCENDSOLVERS when ASCEND is first launched. The value used is, in order of decreasing priority:		ASCEND defines a value for ASCENDSOLVERS when ASCEND is first launched. The value used is, in order of decreasing priority:


	* The ASCENDSOLVERS environment variable if available (appending standard folder to end if it is missing),		* The ASCENDSOLVERS environment variable if available (appending standard folder to end if it is missing),
Line 44:		Line 36:

	If the ASCENDSOLVERS environment variable is defined, and if it ''does not'' contain the standard <tt>solvers</tt> folder (probably <tt>/usr/share/ascend/solvers</tt> or <tt>c:\Program Files\ASCEND\solvers</tt>) then this folder will be added to the '''end''' of the ASCENDSOLVERS path. This is to ensure that the basic minimal set of ASCEND solvers is always available, to avoid confusion.		If the ASCENDSOLVERS environment variable is defined, and if it ''does not'' contain the standard <tt>solvers</tt> folder (probably <tt>/usr/share/ascend/solvers</tt> or <tt>c:\Program Files\ASCEND\solvers</tt>) then this folder will be added to the '''end''' of the ASCENDSOLVERS path. This is to ensure that the basic minimal set of ASCEND solvers is always available, to avoid confusion.


	See also [[IMPORT]].		See also [[IMPORT]].


	== ASCENDTK ==		== ASCENDTK ==

	This environment variable is used to define the location of the Tcl/Tk support files used by the ASCEND Tcl/Tk GUI. It defaults to <tt>$ASCENDDIST/TK</tt>. It has no effect on the PyGTK GUI.		This environment variable is used to define the location of the Tcl/Tk support files used by the ASCEND Tcl/Tk GUI. It defaults to <tt>$ASCENDDIST/TK</tt>. It has no effect on the PyGTK GUI.


	== ASCENDBITMAPS ==		== ASCENDBITMAPS ==

	Defines the location of bitmap files used in the Tcl/Tk GUI. Defaults to <tt>$ASCENDDIST/bitmaps</tt>. It has no affect on the PyGTK GUI.		Defines the location of bitmap files used in the Tcl/Tk GUI. Defaults to <tt>$ASCENDDIST/bitmaps</tt>. It has no affect on the PyGTK GUI.



	== ASCENDDIST ==		== ASCENDDIST ==

	This environment variable is used by the ASCEND Tcl/Tk GUI to define the location of its common files. It can also be used to create 'off root' installations, by allowing ASCEND to locate its files using relative paths. Depending on compile-time settings (specifically the value of <tt>@ASC_ABSOLUTE_PATHS@</tt>), ASCENDDIST defaults to either <tt>$PROGDIR/@ASC_DATADIR_REL_BIN@</tt> or <tt>@ASC_DATADIR@</tt> (where the '<tt>@...@</tt>' variables are defined at compile time, and $PROGDIR is the directory containing the <tt>ascend4</tt> binary).		This environment variable is used by the ASCEND Tcl/Tk GUI to define the location of its common files. It can also be used to create 'off root' installations, by allowing ASCEND to locate its files using relative paths. Depending on compile-time settings (specifically the value of <tt>@ASC_ABSOLUTE_PATHS@</tt>), ASCENDDIST defaults to either <tt>$PROGDIR/@ASC_DATADIR_REL_BIN@</tt> or <tt>@ASC_DATADIR@</tt> (where the '<tt>@...@</tt>' variables are defined at compile time, and $PROGDIR is the directory containing the <tt>ascend4</tt> binary).



	== ASC_GDB ==		== ASC_GDB ==

	If present and non-zero, causes the ASCEND PyGTK GUI to run via the <tt>gdb</tt> debugger (part of GNU GCC). This is made available because, since ASCEND PyGTK is essentially a Python program, it can be a little difficult/inconvenient to run it through a debugger.		If present and non-zero, causes the ASCEND PyGTK GUI to run via the <tt>gdb</tt> debugger (part of GNU GCC). This is made available because, since ASCEND PyGTK is essentially a Python program, it can be a little difficult/inconvenient to run it through a debugger.


	== LD_LIBRARY_PATH ==		== LD_LIBRARY_PATH ==

	When launching ASCEND PyGTK, this environment variable is examined to ensure that it contains the location of <tt>libascend</tt> if necessary. If libascend is installed anywhere except /usr/lib, then its location is added to the end of LD_LIBRARY_PATH before continuing.		When launching ASCEND PyGTK, this environment variable is examined to ensure that it contains the location of <tt>libascend</tt> if necessary. If libascend is installed anywhere except /usr/lib, then its location is added to the end of LD_LIBRARY_PATH before continuing.


	When using the [[IPOPT]] solver, it may also be necessary to use this env var to point to external solvers such as /usr/local/lib/libhsl.so.		When using the [[IPOPT]] solver, it may also be necessary to use this env var to point to external solvers such as /usr/local/lib/libhsl.so.




	~~[[Category:Stubs]]~~
	[[Category:Documentation]]		[[Category:Documentation]]

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

2010-05-13T13:58:44Z

Restored page from Google Cache, uploaded by John Pye

New page

<div class="notice metadata" id="stub">''This article is a '''stub'''. You can help out by <span class="plainlinks">[http://ascendwiki.cheme.cmu.edu/index.php?title=Environment_variables_for_ASCEND&action=edit expanding it]</span>. ''</div>

The following environment variables affect how ASCEND runs.

== ASCENDLIBRARY ==

This variable defines the search path that is used when attempting to load files named on the command line or named in [[REQUIRE]] statements.

This variable a PATH-style variable, which means that on Windows it is semicolon-delimited, whereas on Linux it is colon-delimited. If you are using MSYS/MinGW then be aware that there is no magical transformation; you still need to us semicolons.

When ASCEND loads, the following methods are used in order of decreasing priority:

* the ASCENDLIBRARY environment variable, if present
* the value of <tt>librarypath</tt> from <tt>~/.ascend.ini</tt>, if defined.
* (Windows only) the value of the registry variable <tt>HKLM\SOFTWARE\ASCEND\ASCENDLIBRARY</tt>, if defined
* the default value defined at compile-time.
'''The following is possibly subject to revision:'''

The '''exception''' to this is that ''if'' the ASCENDLIBRARY variable is defined, but it ''does not'' contain the standard [[ASCEND Model Library]] folder (probably <tt>/usr/share/ascend/models</tt> or <tt>c:\Program Files\ASCEND\models</tt>), then it will be added to the '''end''' of the ASCENDLIBRARY path. This is to ensure that the model library will always be available for use with [[REQUIRE]] statements, and to make setting of non-standard paths a little more convenient.

See also [[REQUIRE]], [[IMPORT]].

== ASCENDSOLVERS ==

This variable is used in the <tt>package_load</tt> function that ASCEND uses in [[IMPORT]] statements, when loading external libraries, including solvers.

ASCEND defines a value for ASCENDSOLVERS when ASCEND is first launched. The value used is, in order of decreasing priority:

* The ASCENDSOLVERS environment variable if available (appending standard folder to end if it is missing),
* (Windows only) the registry key <tt>HKLM\SOFTWARE\ASCEND\ASCENDSOLVERS</tt>, if present, or
* a default value defined at compile time.

If ASCENDSOLVERS is not defined, ASCEND next looks for external libraries in the other locations indicated by the ASCENDLIBRARY environment variable, which means that you can store your external libraries as well as your model files in the same directory structure if you wish to.

'''The following is possibly subject to revision:'''

If the ASCENDSOLVERS environment variable is defined, and if it ''does not'' contain the standard <tt>solvers</tt> folder (probably <tt>/usr/share/ascend/solvers</tt> or <tt>c:\Program Files\ASCEND\solvers</tt>) then this folder will be added to the '''end''' of the ASCENDSOLVERS path. This is to ensure that the basic minimal set of ASCEND solvers is always available, to avoid confusion.

See also [[IMPORT]].

== ASCENDTK ==

This environment variable is used to define the location of the Tcl/Tk support files used by the ASCEND Tcl/Tk GUI. It defaults to <tt>$ASCENDDIST/TK</tt>. It has no effect on the PyGTK GUI.

== ASCENDBITMAPS ==

Defines the location of bitmap files used in the Tcl/Tk GUI. Defaults to <tt>$ASCENDDIST/bitmaps</tt>. It has no affect on the PyGTK GUI.

== ASCENDDIST ==

This environment variable is used by the ASCEND Tcl/Tk GUI to define the location of its common files. It can also be used to create 'off root' installations, by allowing ASCEND to locate its files using relative paths. Depending on compile-time settings (specifically the value of <tt>@ASC_ABSOLUTE_PATHS@</tt>), ASCENDDIST defaults to either <tt>$PROGDIR/@ASC_DATADIR_REL_BIN@</tt> or <tt>@ASC_DATADIR@</tt> (where the '<tt>@...@</tt>' variables are defined at compile time, and $PROGDIR is the directory containing the <tt>ascend4</tt> binary).

== ASC_GDB ==

If present and non-zero, causes the ASCEND PyGTK GUI to run via the <tt>gdb</tt> debugger (part of GNU GCC). This is made available because, since ASCEND PyGTK is essentially a Python program, it can be a little difficult/inconvenient to run it through a debugger.

== LD_LIBRARY_PATH ==

When launching ASCEND PyGTK, this environment variable is examined to ensure that it contains the location of <tt>libascend</tt> if necessary. If libascend is installed anywhere except /usr/lib, then its location is added to the end of LD_LIBRARY_PATH before continuing.

When using the [[IPOPT]] solver, it may also be necessary to use this env var to point to external solvers such as /usr/local/lib/libhsl.so.

[[Category:Stubs]]
[[Category:Documentation]]