GILDAS GITLAB OMS

Installation Guidelines

Table of contents

I - RELEASE NOTES

Release notes are available in the NEWS.

II - DOWNLOAD

1 - Sources from GILDAS homepage

Linux/OSX versions of GILDAS are distributed only as sources because binaries are not portable (due to the many different possible combinations of processors, operating system and compilers). Fetch the sources from the download area. You have to pick a tarball named gildas-src-mmmyyv.tar.xz. Some hints:

2 - Sources from GIT repository

Get the last monthly version from the public GIT repository:

git clone \
  -b ryy-mmm https://git.iram.fr/gildas/gildas.git gildas-src-mmmyy

This command creates the sources of GILDAS in a new gildas-src-mmmyy directory. The -b ryy-mmm switch enables you to choose the monthly release you need. Be careful, you here need only the 3 first letters of the current month and the last two digits of the current year. No letter is required: you will automatically end up with the last bug fix of this monthly release.

In practice, if you want to fetch the December 2022 sources, just type:

git clone \
  -b r22-dec https://git.iram.fr/gildas/gildas.git gildas-src-dec22

It is also possible to update this clone at any moment:

cd gildas-src-dec22
git pull  # Fetch the last commits in the current branch

If new monthly versions have been released, you should be able to check them out after git pull, e.g.

git checkout r23-jan  # Fetch January 2023 release

Do not forget to completely clean and rebuild GILDAS after an update (make distclean && make).

3 - Documentation from GILDAS homepage

Compiled documentation are also distributed as tarballs in the download area. You have to pick a tarball named gildas-doc-mmmyy.tar.xz.

III - REQUIREMENTS

1 - Supported systems

GILDAS compiles successfully and is (at least minimally) tested on:

Processor Operating system Environment
x86_64 Linux Native
x86_64 (Intel) macOS Native
x86_64 (Intel) macOS MacPorts
arm64 (Apple Silicon) macOS Native
arm64 (Apple Silicon) macOS MacPorts

The reference system at IRAM is Debian 12 (x86_64) with Intel Fortran 2021 and gfortran 12.2.0.

2 - Material

3 - Needed tools to build executables from sources

Successful building of GILDAS binaries on a UNIX/Linux/OSX system minimally requires:

4 - Needed tools to build the documentation

Successful building of PDF/HTML documentation minimally requires recent versions of:

For your convenience, we distribute compiled PDF/HTML documentation in case you do not have those tools. See the distribution section of the GILDAS web page:

https://www.iram.fr/~gildas/dist/

IV - INSTALL UNDER MACOS

Gildas and its dependencies can be installed as a MacPorts package.

1 - Prerequisites

Both installation methods 2 and 3 below require the installation of:

2 - MacPorts package

Gildas is available as a standard package in the MacPorts distribution. Unless you are an advanced user (see below: Installation from sources), this is the recommended way to install Gildas under Mac OS. Once MacPorts and XQuartz are installed, Gildas installation is straightforward. Type:

sudo port install gildas

The parallelization is enabled by default. The Gildas programs are ready to use right after (type e.g. greg in a terminal prompt). Usually the package is updated a few days after a source release (every month), so that the latest enhancements or bug fixes in Gildas are quickly available to Mac users. Updating to the newest release is done with the command:

sudo port upgrade gildas

You might need to update MacPorts itself first:

sudo port selfupdate

3 - Installation from sources

As an alternate solution, it is possible to compile Gildas by yourself. You have to use MacPorts to install first the Gildas dependencies.

sudo port install gcc14
sudo port select gcc # show available arguments
sudo port select gcc mp-gcc14  # Choose the desired one
sudo port install gtk3
sudo port install pkgconfig
sudo port install groff
sudo port variants cfitsio

Then install the correct "variant" e.g.

sudo port install cfitsio +gcc14

4 - Troubleshooting

rsync://rsync.macports.org/release/ports/ [default]

with:

#rsync://rsync.macports.org/release/ports/ [default]
https://www.macports.org/files/ports.tar.gz [default]

and run sudo port sync instead of sudo port selfupdate.

sudo port install gcc14
sudo port install gtk3
sudo port select gcc # show available arguments
sudo port select gcc mp-gcc14
port select python python27-apple

However, note that this may break other Python-related applications installed with MacPorts.

:info:build FATAL:/opt/local/bin/../libexec/as/x86_64/as:
I don't understand 'm' flag!

This problem is described here: https://trac.macports.org/ticket/56919 In short, the assembler program (as) which is used is not the correct one. Type:

sudo port install cctools +xcode

to switch to the correct version. Then you can resume the Gildas installation.

:info:build ld: unexpected token: !tapi-tbd-v3 file
'/System/Library/Frameworks//CoreFoundation.framework/CoreFoundation.tbd'
for architecture x86_64

This problem is described here: http://mac-os-forge.2317878.n4.nabble.com/linker-errors-ld-unexpected-token-tapi-tbd-v3-file-td363061.html#a363073 In short, you should type:

sudo port install ld64 +ld64_xcode

Then you should retry Gildas installation. You should clean the previous attempt first:

sudo port clean gildas

Then proceed:

sudo port install gildas + any option if needed
Gtk-WARNING **: xx:xx:xx.xxx: cannot open display

check that XQuartz server is installed and running (see Prerequisites section above).

Gtk-WARNING **: Locale not supported by C library.
                Using the fallback 'C' locale.
sudo port install texlive-basic      # provides ps2pdf
sudo port install texlive-fontutils  # provides epstopdf

V - INSTALL UNDER LINUX

1 - Dependencies

Linux version of GILDAS are distributed only as sources because binaries are not portable (due to the many different possible combinations of processors, operating system and compilers). We thus tried to ease building as much as possible.

In addition to the standard developer tools (make, gcc, nroff, etc), the following dependencies must be installed. Root privileges are required here.

2 - Compile and install (binaries)

Building the binaries should just need the following sequence of commands. Gildas itself does not need root privileges for installation and execution: it can be unzipped anywhere and installed by any user for its own needs.

unxz gildas-src-mmmyya.tar.xz
tar -xf gildas-src-mmmyya.tar

or even simpler, let tar uncompress the archive by itself (automatic detection from the file extension):

tar -xf gildas-src-mmmyya.tar.xz
cd gildas-src-mmmyya

At this stage, if you are not under a sh-compatible shell, you have to switch to e.g. bash. Then load the compilation environment:

source admin/gildas-env.sh

You can optionally add the compiler to be used with the option -c (e.g. source admin/gildas-env.sh -c gfortran). Read carefully the messages and warnings returned by the command. If everything seem correct, then compile and install Gildas:

make
make install

Finally, follow the instructions at the end of the make install process. Installation is successful if you can start the programs greg or class from a new terminal.

3 - Post-installation (binaries)

After the installation is successful, you can optionally remove the sources and compilation directory (gildas-src-mmmyy). This is useful only to save disk space. On the other hand, this means that in case of update (e.g. for GIT-based downloads) you will have to recompile everything again from scratch.

4 - Compile and/or install (documentation)

mv gildas-doc-mmmyya.tar.xz gildas-exe-mmmyya/
cd gildas-exe-mmmyya/
tar -xf gildas-doc-mmmyya.tar.xz
make doc
make install-doc

To compile and install the HTML documentation, please type:

make html
make install-html

5 - Troubleshooting

Gtk-WARNING **: Locale not supported by C library.
                Using the fallback 'C' locale

This is not a GILDAS issue. This means that your locale settings (type locale in a terminal) indicate one or more locales that are not installed on your system (type locale -a in a terminal for the full list). You should fix your environment variables in order to use an installed locale (e.g. export LANG=en_US.utf8, beware this may change your programs behavior regarding language), or install the missing locale(s).

astro: /home/user/anaconda/lib/libstdc++.so.6: version
       `GLIBCXX_3.4.21' not found (required by /home/user/
       gildas-exe-jan17a/x86_64-ubuntu16.04-gfortran/lib/libatm.so)

This happens because Anaconda gives precedence to its own binaries and include files (duplicate but different versions of system ones) in the user's environment. There are several ways out of this issue:

function anaconda() {
    export PATH=...
    export LD_LIBRARY_PATH=...
    anaconda
}

VI - INSTALL UNDER MS WINDOWS

MS Windows binaries are not available. If you need to run GILDAS under a MS Windows computer, you can install a Linux virtual machine and follow the installation instructions as explained in the previous section.

VII - UNINSTALL

1 - Under Linux

2 - Under MacPorts

sudo port installed gildas

You will see a list of versions with a @ name, e.g.

gildas @201808b_0+gcc7
gildas @201808b_0+gcc7+openmp
gildas @201809a_0+gcc7+openmp (active)

Uninstalling a single version can be done with e.g.

sudo port uninstall gildas @201808b_0+gcc7

Uninstalling several versions can be done with:

sudo port uninstall gildas

Answer at the prompt which versions are to be uninstalled.