\(\newcommand{\B}[1]{ {\bf #1} }\) \(\newcommand{\R}[1]{ {\rm #1} }\)

install_settings.py

View page source

Settings Used by Install and Test Scripts

You must edit the file bin/install_settings.py to change these settings from their default values.

Syntax

The syntax cases below must be executed from the cppad_py.git directory; i.e., the directory that cppad_py was cloned into.

Python

This sets install_settings to a python dictionary that has a key-value pair for of the settings listed below:

sys.path.insert(0, os.getcwd() + '/bin')
import install_settings
install_settings = install_settings.install_settings()
sys.path.pop(0)

Bash

This prints the value for each of the install settings:

bin/install_settings.py

This sets a bash variable to its value for each of the install settings:

eval $(bin/install_settings.py)

cmake_install_prefix

This prefix is used to install cppad and cppad_mixed. The old_setup.py script also uses this prefix to install cppad_py. The new setup.py installs cppad_py using pip , so its prefix is set independently.

cmake_install_prefix = '$HOME/prefix/cppad_py'

1. If this prefix starts with ‘’/’’ , it is an absolute path; e.g., /usr/local.

2. If it does not start with / , it is relative to the cppad_py.git directory. The install_settings return value for cmake_install prefix will be the corresponding absolute path.

3. It may include the shell variable $HOME but no other variables; e.g; $HOME/prefix . The install_settings return value for cmake_install prefix will have $HOME expanded to an absolute path.

extra_cxx_flags

Extra compiler flags used when compiling c++ code not including the debugging and optimization flags. The ones below are example flags used by g++:

extra_cxx_flags = '-Wall -pedantic-errors -Wno-unused-result -std=c++11'

build_type

This must be must debug or release . The debug version has more error messaging while the release version runs faster.

build_type = 'release'

If the build_type is not debug or release, install_settings.py will terminate with an error message.

symbolic_link

This must be must true or false . If it is true , the actual prefix used for the install is

      cmake_install_prefix.build_type

and a soft link is created from cmake_install_prefix to this directory. This way you can switch between testing debug and release without re-running bin/get_cppad.sh` or bin/get_cppad_mixed.sh .

symbolic_link = 'true'

build

The subdirectory

      build.build_type

is used by old_setup.py to compile and test the software and a soft link is created from build to this subdirectory. The new setup.py uses the dist directory to build the cppad_py package.

include_mixed

This flag is true (false) if we are (are not) including the python cppad_mixed interface.

include_mixed = 'false'

If it is true, the install script bin/get_cppad_mixed.sh must be used to install CppAD together with the all the other cppad_mixed requirements. Otherwise, bin/get_cppad.sh should be used to install CppAD. If the include_mixed is not true or false, install_settings.py will terminate with an error message.

test_cppad

This must be must true or false . CppAD has a huge test suite and this can take a significant amount of time, but it may be useful if you have problems.

test_cppad = 'false'

verbose_makefile

This flag is true (false) a verbose version of the build description will (will not) be printed.

verbose_makefile = 'false'

If the verbose_makefile is not true or false, install_settings.py will terminate with an error message.