SCons options for building ASCEND

From ASCEND
Jump to: navigation, search

The following listing gives the current (as of version 0.9.5.112) command-line options for the ASCEND build script that runs using scons. These options are subject to change. You can always get the current list by typing scons -Qh in the top-level directory in the ASCEND source code distribution. See also Building ASCEND. The values listed here as 'actual' are just the values that happened to be there at a particular random point in time on my machine.

CC: C Compiler command
    default: None
    actual: ccache gcc

CXX: C++ Compiler command
    default: None
    actual: ccache g++

GCOV: Whether to enable coverage testing in object code (yes|no)
    default: False
    actual: 0

WITH_GCCVISIBILITY: Whether to use GCC Visibility features (only applicable if available) (yes|no)
    default: True
    actual: 1

WITH_SIGNALS: Whether to permit use of signals for flow control in the C-level code (yes|no)
    default: True
    actual: 1

WITH_TCLTK: Set to False if you don't want to build the original Tcl/Tk GUI. (yes|no)
    default: True
    actual: 1

WITH_PYTHON: Set to False if you don't want to build Python wrappers. (yes|no)
    default: True
    actual: 1

WITH_SOLVERS: List of the solvers you want to build. The default is the minimum that works. The option 'LSOD' is provided for backwards compatibility; the value 'LSODE' is preferred.
    (all|none|comma-separated list of names)
    allowed names: QRSLV MPS SLV OPTSQP NGSLV CMSLV LRSLV MINOS CONOPT LSODE LSOD OPTSQP IDA TRON
    default: QRSLV,CMSLV,LSODE,IDA,CONOPT,LRSLV,TRON
    actual: CMSLV CONOPT IDA LRSLV LSODE QRSLV TRON

WITH_DOC: Should we try to build and install help files? If not, ASCEND will access online help files (yes|no)
    default: True
    actual: 1

WITH_DOC_BUILD: If true, we'll attempt to build docs. Set false, we'll assume we already have then (eg from the tarball) (yes|no)
    default: $WITH_DOC
    actual: 1

WITH_DOC_INSTALL: If true, SCons will install the documentation file(s). If false, assume rpm or dpkg is going to do it. (yes|no)
    default: $WITH_DOC
    actual: 1

HELP_ROOT: Location of the main help file
    default: $INSTALL_DOC/book.pdf
    actual: /usr/share/doc/ascend-0.9.5.112/book.pdf

WITH_BINTOKEN: Enable bintoken support? This means compiling models as C-code before running them, to increase solving speed for large models. (yes|no)
    default: False
    actual: 0

DEFAULT_ASCENDLIBRARY: Set the default value of the ASCENDLIBRARY -- the location where ASCEND will look for models when running ASCEND
    default: $INSTALL_MODELS
    actual: /usr/share/ascend/models

DEFAULT_ASCENDSOLVERS: Set the default value of ASCENDSOLVERS -- the location where ASCEND will look for solver shared-library files
    default: $INSTALL_SOLVERS
    actual: /usr/share/ascend/solvers

SWIG: SWIG location, probably only required for MinGW and MSVC users. Enter the location as a Windows-style path, for example 'c:\msys\1.0\home\john\swigwin-1.3.29\swig.exe'.
    default: None
    actual: swig

WITH_CUNIT: You can disable CUnit tests with this option. This will basically stop SCons from parsing the SConscript files relating to the 'test' target, which just might make things marginally faster. Probably you can just ignore this option though. SCons will sniff for Cunit but build the tests only if you specify the 'test' target. (yes|no)
    default: True
    actual: 1

WITH_MMIO: Include support for exporting matrices in Matrix Market format (yes|no)
    default: True
    actual: 1

DEFAULT_PREFIX: Where are most of the shared libraries located on your system?
    ( yes | no | /path/to/DEFAULT_PREFIX )
    default: /usr
    actual: /usr

CUNIT_PREFIX: Where are your CUnit files?
    ( yes | no | /path/to/CUNIT_PREFIX )
    default: $DEFAULT_PREFIX
    actual: /usr

CUNIT_CPPPATH: Where are your CUnit include files?
    ( yes | no | /path/to/CUNIT_CPPPATH )
    default: $CUNIT_PREFIX/include
    actual: /usr/include

CUNIT_LIBPATH: Where are your CUnit libraries?
    ( yes | no | /path/to/CUNIT_LIBPATH )
    default: $CUNIT_PREFIX/lib
    actual: /usr/lib

SUNDIALS_PREFIX: Prefix for your IDA install (IDA ./configure --prefix)
    ( yes | no | /path/to/SUNDIALS_PREFIX )
    default: /usr
    actual: /usr

SUNDIALS_CPPPATH: Where is your ida.h?
    default: $SUNDIALS_PREFIX/include
    actual: /usr/include

SUNDIALS_LIBPATH: Where are your SUNDIALS libraries installed?
    default: $SUNDIALS_PREFIX/lib
    actual: /usr/lib

SUNDIALS_LIBS: Where are your SUNDIALS libraries installed?
    default: ['sundials_nvecserial', 'sundials_ida', 'm']
    actual: sundials_nvecserial sundials_ida m

CONOPT_PREFIX: Prefix for your CONOPT install (CONOPT ./configure --prefix)
    ( yes | no | /path/to/CONOPT_PREFIX )
    default: /usr
    actual: /usr

CONOPT_LIB: Library linked to for CONOPT
    default: consub3
    actual: consub3

CONOPT_CPPPATH: Where is your conopt.h?
    default: $CONOPT_PREFIX/include
    actual: /usr/include

CONOPT_LIBPATH: Where is your CONOPT library installed?
    default: $CONOPT_PREFIX/lib
    actual: /usr/lib

CONOPT_DLPATH: What is the default search path that ASCEND should use when dlopening the CONOPT library at runtime?
    default: $CONOPT_PREFIX/lib:/usr/local/lib
    actual: /usr/lib:/usr/local/lib

CONOPT_ENVVAR: What environment variable should be used at runtime to override the default search location for CONOPT DLL/SO?
    default: CONOPT_PATH
    actual: CONOPT_PATH

TRON_ENVVAR: What environment variable should be used at runtime to override the default search location for TRON DLL/SO?
    default: TRON_PATH
    actual: TRON_PATH

TRON_LIB: Library linked to for TRON
    default: tron
    actual: tron

TRON_PREFIX: Prefix for your TRON install
    default: /usr
    actual: /usr

TRON_DLPATH: What is the default search path that ASCEND should use when dlopening the TRON library at runtime?
    default: $TRON_PREFIX/lib
    actual: /usr/lib

F2C_LIB: F2C library (eg. g2c, gfortran, f2c)
    default: gfortran
    actual: gfortran

F2C_LIBPATH: Directory containing F2C library (i.e. g2c, gfortran, f2c, etc.), if not already accessible
    ( yes | no | /path/to/F2C_LIBPATH )
    default: off
    actual: 0

FORTRAN: Fortran compiler (eg g77, gfortran)
    default: gfortran
    actual: gfortran

TCL: Base of Tcl distribution
    default: /usr
    actual: /usr

TCL_CPPPATH: Where are your Tcl include files?
    default: /usr/include/tcl8.4
    actual: /usr/include/tcl8.4

TCL_LIBPATH: Where are your Tcl libraries?
    default: $TCL/lib
    actual: /usr/lib

TCL_LIB: Name of Tcl lib (eg 'tcl' or 'tcl83'), for full path to static library (if STATIC_TCLTK is set)
    default: tcl8.4
    actual: tcl8.4

TK_CPPPATH: Where are your Tk include files?
    default: $TCL_CPPPATH
    actual: /usr/include/tcl8.4

TK_LIBPATH: Where are your Tk libraries?
    default: $TCL_LIBPATH
    actual: /usr/lib

TK_LIB: Name of Tk lib (eg 'tk' or 'tk83'), or full path to static library
    default: tk8.4
    actual: tk8.4

STATIC_TCLTK: Set true for static linking for Tcl/Tk and TkTable. EXPERIMENTAL (yes|no)
    default: False
    actual: 0

TKTABLE_LIBPATH: Location of TkTable static library
    default: $TCL_LIBPATH/Tktable2.8
    actual: /usr/lib/Tktable2.8

TKTABLE_LIB: Stem name of TkTable (eg tktable2.8, no ".so" or "lib") shared library, or full path of static tktable (/usr/lib/...)
    default: Tktable2.8
    actual: Tktable2.8

TKTABLE_CPPPATH: Location of TkTable header file
    default: $TCL_CPPPATH
    actual: /usr/include/tcl8.4

X11: Base X11 directory. Only used when STATIC_TCLTK is turned on. EXPERIMENTAL
    default: /usr/X11R6
    actual: /usr/X11R6

X11_LIBPATH: Location of X11 lib. EXPERIMENTAL
    default: $X11/lib
    actual: /usr/X11R6/lib

X11_CPPPATH: Location of X11 includes. EXPERIMENTAL
    default: $X11/include
    actual: /usr/X11R6/include

X11_LIB: Name of X11 lib. EXPERIMENTAL
    default: X11
    actual: X11

INSTALL_PREFIX: Root location for installed files
    default: /usr/local
    actual: /usr

INSTALL_BIN: Location to put binaries during installation
    default: $INSTALL_PREFIX/bin
    actual: /usr/bin

INSTALL_LIB: Location to put libraries during installation
    default: $INSTALL_PREFIX/lib
    actual: /usr/lib

INSTALL_SHARE: Common shared-file location on this system
    default: $INSTALL_PREFIX/share
    actual: /usr/share

INSTALL_ASCDATA: Location of ASCEND shared data (TK, python, models etc)
    default: $INSTALL_SHARE/ascend
    actual: /usr/share/ascend

INSTALL_MODELS: Location of ASCEND model files (.a4c,.a4l,.a4s)
    default: $INSTALL_ASCDATA/models
    actual: /usr/share/ascend/models

INSTALL_SOLVERS: Location of ASCEND solvers
    default: $INSTALL_ASCDATA/solvers
    actual: /usr/share/ascend/solvers

INSTALL_DOC: Location of ASCEND documentation files
    default: $INSTALL_SHARE/doc/ascend-0.9.5.112
    actual: /usr/share/doc/ascend-0.9.5.112

INSTALL_INCLUDE: Location to put header files during installation
    default: $INSTALL_PREFIX/include
    actual: /usr/include

INSTALL_ROOT: For use by RPM only: location of %{buildroot} during rpmbuild
    default: 
    actual: /home/john/ascend/debian/tmp/

PYGTK_ASSETS: Default location for Glade assets (placed in pygtk/config.py)
    default: $INSTALL_ASCDATA/glade/
    actual: /usr/share/ascend/glade/

DEBUG: Compile source with debugger symbols, eg for use with 'gdb' (yes|no)
    default: False
    actual: 1

MALLOC_DEBUG: Compile with debugging version of MALLOC. Required for full CUnit testing (yes|no)
    default: False
    actual: 0

DMALLOC_PREFIX: Where are your dmalloc files?
    ( yes | no | /path/to/DMALLOC_PREFIX )
    default: /usr
    actual: /usr

DMALLOC_CPPPATH: Where are your dmalloc include files?
    ( yes | no | /path/to/DMALLOC_CPPPATH )
    default: $DEFAULT_PREFIX/include
    actual: /usr/include

DMALLOC_LIBPATH: Where are your dmalloc libraries?
    ( yes | no | /path/to/DMALLOC_LIBPATH )
    default: $DEFAULT_PREFIX/lib
    actual: /usr/lib

WITH_DMALLOC: Link to the DMALLOC library (if available) for debugging of memory usage. (yes|no)
    default: False
    actual: 0

MFGRAPH_PREFIX: Where are your MFGRAPH files?
    ( yes | no | /path/to/MFGRAPH_PREFIX )
    default: /usr
    actual: /usr

MFGRAPH_CPPPATH: Where are your MFGRAPH include files?
    ( yes | no | /path/to/MFGRAPH_CPPPATH )
    default: $DEFAULT_PREFIX/include
    actual: /usr/include

MFGRAPH_LIBPATH: Where are your MFGRAPH libraries?
    ( yes | no | /path/to/MFGRAPH_LIBPATH )
    default: $DEFAULT_PREFIX/lib
    actual: /usr/lib

WITH_MFGRAPH: Link to the MFGRAPH library (if available, for generating incidence graphs) (yes|no)
    default: True
    actual: 1

UFSPARSE_PREFIX: Where are your UFSPARSE files?
    ( yes | no | /path/to/UFSPARSE_PREFIX )
    default: /usr
    actual: /usr

UFSPARSE_CPPPATH: Where are your UFSPARSE include files?
    ( yes | no | /path/to/UFSPARSE_CPPPATH )
    default: $DEFAULT_PREFIX/include
    actual: /usr/include

UFSPARSE_LIBPATH: Where are your UFSPARSE libraries?
    ( yes | no | /path/to/UFSPARSE_LIBPATH )
    default: $DEFAULT_PREFIX/lib
    actual: /usr/lib

WITH_UFSPARSE: Link to the UFSPARSE library (if available, for additional sparse matrix routines) (yes|no)
    default: True
    actual: 1

DISTTAR_NAME: Stem name of the tarball created by 'scons dist'. So for 'ascend-aaa.tar.bz2', set this to 'ascend-aaa'.
    default: ascend-0.9.5.112
    actual: ascend-0.9.5.112

RELEASE: Release number for use in RPM spec file. This should always start with a zero for releases made by the ASCEND group, in order that third parties can make 'patch' releases of higher version numbers.
    default: 0
    actual: 0

ABSOLUTE_PATHS: Whether to use absolute or relative paths in the installed Tcl/Tk interface. If you want to build an RPM, set this to false. (yes|no)
    default: True
    actual: 1

WIN_INSTALLER_NAME: Name of the installer .exe to create under Windows (minus the '.exe')
    default: ascend-0.9.5.112-py2.5.exe
    actual: ascend-0.9.5.112-py2.5.exe

WITH_XTERM_COLORS: Set to 0 if you don't want xterm colour codes in the console output (yes|no)
    default: True
    actual: 1

WITH_EXTFNS: Set to 0 if you don't want to attempt to build the external modules bundled with ASCEND (yes|no)
    default: True
    actual: 1

WITH_SCROLLKEEPER: Set to to 1 if you want to install an OMF file that can be read by scrollkeeper (eg Yelp on GNOME) (yes|no)
    default: False
    actual: 0

WITH_GCCVISIBILITY: Whether to use GCC Visibility extensions when building with GCC 4.0 (yes|no)
    default: True
    actual: 1

Use scons -H for help about command-line options.