{"id":528,"date":"2024-11-04T19:20:28","date_gmt":"2024-11-04T19:20:28","guid":{"rendered":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/?page_id=528"},"modified":"2025-02-12T16:54:28","modified_gmt":"2025-02-12T16:54:28","slug":"installation-steps","status":"publish","type":"page","link":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/installation-steps\/","title":{"rendered":"Installation Steps"},"content":{"rendered":"\n<h2>Required Packages<\/h2>\n\n\n\n<p>The installation of the simulation software package requires the following packages:<\/p>\n\n\n\n<ul><li><em>gcc, g++, gfortran<\/em><\/li><li><em>gsl<\/em><\/li><li><em>cmake<\/em><\/li><li><em>cgal<\/em><\/li><li><em>boost<\/em><\/li><\/ul>\n\n\n\n<p>If you are using macOS, we recommend using homebrew (eg.: <code>brew install gcc<\/code>, if you are not using homebrew yet, further information can be found <a href=\"https:\/\/brew.sh\">here<\/a>).<\/p>\n\n\n\n<p>The Ubuntu versions are named:<\/p>\n\n\n\n<ul><li><em>libreadline-dev<\/em><\/li><li><em>libncurses-dev<\/em><\/li><li><em>libexpat1-dev<\/em><\/li><li><em>libcmocka-dev<\/em><\/li><li><em>libboost-dev<\/em><\/li><li><em>libgsl0-dev<\/em><\/li><li><em>libcgal-dev<\/em><\/li><li><em>cmake<\/em><\/li><li><em>autoconf<\/em><\/li><li><em>pkg-config<\/em><\/li><\/ul>\n\n\n\n<p>These are the ubuntu-linux package names, other Linux distributions will use similar package names. We also recommend that you have a current version of NASA&#8217;s HEASOFT package: <a href=\"https:\/\/heasarc.gsfc.nasa.gov\/lheasoft\/\">https:\/\/heasarc.gsfc.nasa.gov\/lheasoft\/<\/a><br>Please be aware that the HEASOFT version 6.32 does currently not work with SIXTE.<\/p>\n\n\n\n<h2 id=\"Installing-SIMPUT\">Installing SIMPUT<\/h2>\n\n\n\n<p>Once you have downloaded the tar archive with a release of SIMPUT, you have to extract the archive:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>tar xvzf simput-x.y.z.tar.gz\ncd simput-x.y.z<\/code><\/pre>\n\n\n\n<p>You compile and install the simulation software to a directory <code>simputdir<\/code> with the following commands:<\/p>\n\n\n\n<p><strong>1. Configure project and create build directory:<\/strong><\/p>\n\n\n\n<p><code>cmake -S . -B build -DCMAKE_INSTALL_PREFIX=simputdir<\/code><\/p>\n\n\n\n<p>where <code>simputdir<\/code> specifies the installation directory.<\/p>\n\n\n\n<p>Notes:<\/p>\n\n\n\n<ul><li>To force the usage of a specific boost installation, use <code>-DBoost_NO_SYSTEM_PATHS=ON -DBoost_NO_BOOST_CMAKE=ON -DBOOST_ROOT=...<\/code><\/li><\/ul>\n\n\n\n<p><strong>2. Compile and link:<\/strong><\/p>\n\n\n\n<p><code>cmake --build build<\/code><\/p>\n\n\n\n<p>Additional variables and options:<\/p>\n\n\n\n<ul><li>Activate verbose output (useful for debugging; prints all output of gcc, g++, etc.): <code>--verbose<\/code><\/li><li>Parallel build: <code>--parallel n<\/code> (where n is the maximum number of concurrent processes)<\/li><\/ul>\n\n\n\n<p><strong>3. Install:<\/strong><\/p>\n\n\n\n<p><code>cmake --install build<\/code><\/p>\n\n\n\n<h2>Installing SIXTE<\/h2>\n\n\n\n<p>Installing SIXTE is similar to SIMPUT. Extract the downloaded SIXTE tar archive and perform the normal build process. We recommend you install SIXTE in the same location as SIMPUT (i.e, installing it in <code>simputdir<\/code>).<\/p>\n\n\n\n<p>The following CMake commands must be executed in the top level SIXTE source directory:<\/p>\n\n\n\n<p><strong>1. Configure project and create build directory:<\/strong><\/p>\n\n\n\n<p><code>cmake -S . -B build -DCMAKE_INSTALL_PREFIX=sixtedir<\/code><\/p>\n\n\n\n<p>where <code>sixtedir<\/code> specifies the installation directory.<\/p>\n\n\n\n<p>Additional variables and options:<\/p>\n\n\n\n<ul><li>Directory that contains SIMPUT installation (necessary if SIMPUT is installed to a different directory than SIXTE):<br><code>-DSIMPUT_ROOT=...<\/code><\/li><li>Directory that contains GSL installation:<br><code>-DGSL_ROOT_DIR=...<\/code><br>Libraries are expected at <code>$GSL_ROOT_DIR\/lib<\/code> and the GSL headers at <code>$GSL_ROOT_DIR\/include\/gsl<\/code><\/li><\/ul>\n\n\n\n<p>Analogous (if the respective library is not found) also for<\/p>\n\n\n\n<ul><li><code>-DBOOST_ROOT=...<\/code><\/li><li><code>-DCGAL_ROOT=...<\/code><\/li><li><code>-DGMP_INCLUDE_DIR=...<\/code>, <code>-DGMP_LIBRARIES_DIR=...<\/code><\/li><li><code>-DMPFR_INCLUDE_DIR=...<\/code>, <code>-DMPFR_LIBRARIES_DIR=...<\/code><\/li><\/ul>\n\n\n\n<p>Alternatively, you can use the <code>pkg-config<\/code> tool. If you have the relevant files for your libraries (usually <code>${LIBRARY}.pc<\/code>) in a system directory, you can specify this directory before invoking CMake via<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>export PKG_CONFIG_PATH=\/path\/to\/pkgconfig<\/code><\/pre>\n\n\n\n<p>And then continuing as above. On MacOS, this path may be <code>\/opt\/local\/lib\/pkgconfig<\/code> or, if you are using homebrew, <code>\/opt\/homebrew\/lib\/pkgconfig<\/code><\/p>\n\n\n\n<p>Notes:<\/p>\n\n\n\n<ul><li>To force the usage of a specific boost installation, use <code>-DBoost_NO_SYSTEM_PATHS=ON -DBoost_NO_BOOST_CMAKE=ON -DBOOST_ROOT=...<\/code><\/li><\/ul>\n\n\n\n<p><strong>2. Compile and link:<\/strong><\/p>\n\n\n\n<p><code>cmake --build build<\/code><\/p>\n\n\n\n<p>Additional variables and options:<\/p>\n\n\n\n<ul><li>Activate verbose output (useful for debugging; prints all output of gcc, g++, etc.): <code>--verbose<\/code><\/li><li>Parallel build: <code>--parallel n<\/code> (where n is the maximum number of concurrent processes)<\/li><\/ul>\n\n\n\n<p><strong>3. Install:<\/strong><\/p>\n\n\n\n<p><code>cmake --install build<\/code><\/p>\n\n\n\n<h2>Installing from Git<\/h2>\n\n\n\n<p>If you want to contribute to the source development or if you want to run the cutting edge version of the software, you need to install from our code tree, which is maintained with the version control system <a href=\"http:\/\/git-scm.com\/\">Git<\/a>. Both, SIMPUT and SIXTE are available in this form. If Git is installed on your system, you can directly clone the repositories containing the source code using the following commands:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>git clone http:\/\/www.sternwarte.uni-erlangen.de\/git.public\/sixt\/ \ngit clone http:\/\/www.sternwarte.uni-erlangen.de\/git.public\/simput.git\/ \n<\/code><\/pre>\n\n\n\n<p>You can then run the same installation steps as above.<\/p>\n\n\n\n<p>In case you want to contribute to any of the two repositories, we recommend that you contact us (sixte-support@sternwarte.uni-erlangen.de).<\/p>\n\n\n\n<h2>Using the Tools<\/h2>\n\n\n\n<p>To be able to use the tools, you have to set the environment variables <code>$SIMPUT<\/code> and <code>$SIXTE<\/code> to the respective installation directories and source the <code>sixte-install.csh\/sh<\/code> script:<\/p>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<p><strong>In a C shell (csh\/tcsh)<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>setenv SIMPUT simputdir\nsetenv SIXTE sixtedir\nsource ${SIXTE}\/bin\/sixte-install.csh<\/code><\/pre>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p><strong>In a Bash shell (bash\/sh\/zsh)<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>export SIMPUT=simputdir\nexport SIXTE=sixtedir\n. ${SIXTE}\/bin\/sixte-install.sh <\/code><\/pre>\n<\/div>\n<\/div>\n\n\n\n<p>These lines can also be set in the ~\/.cshrc, or ~\/.bashrc respectively. The required steps are also described in greater detail the file <em>INSTALL.txt<\/em>, which is contained in the project directory.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Required Packages The installation of the simulation software package requires the following packages: gcc, g++, gfortran gsl cmake cgal boost If you are using macOS, we recommend using homebrew (eg.: brew install gcc, if you are not using homebrew yet, further information can be found here). The Ubuntu versions are&#8230;<\/p>\n","protected":false},"author":1085,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"categories":[],"tags":[],"_links":{"self":[{"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/pages\/528"}],"collection":[{"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/users\/1085"}],"replies":[{"embeddable":true,"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/comments?post=528"}],"version-history":[{"count":19,"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/pages\/528\/revisions"}],"predecessor-version":[{"id":619,"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/pages\/528\/revisions\/619"}],"wp:attachment":[{"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/media?parent=528"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/categories?post=528"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.sternwarte.uni-erlangen.de\/sixte\/wp-json\/wp\/v2\/tags?post=528"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}