Installation¶

The following section describes the installation of the C and Fortran interface of the library. If you want to install the interface for another programming language, you have to follow the instructions of the manual of that language.

Unix-like system (Linux, Mac OS X, BSD, Cygwin, ...)¶

Quick instructions¶

Here are the quick steps needed to install the library on Unix systems. In the following instructions, you must replace /home/mylogin/mydir by the directory location where you want to install calceph.

If you use the gnu gcc and gfortran compilers, the steps are :

tar xzf calceph-3.5.5.tar.gz
cd calceph-3.5.5
./configure --disable-shared CC=gcc FC=gfortran --prefix=/home/mylogin/mydir
make check && make install

If you use the Intel c++ and fortran compilers, the steps are :

tar xzf calceph-3.5.5.tar.gz
cd calceph-3.5.5
./configure --disable-shared CC=icc FC=ifort --prefix=/home/mylogin/mydir
make check && make install

If you use the llvm clang and flang compilers, the steps are :

tar xzf calceph-3.5.5.tar.gz
cd calceph-3.5.5
./configure --disable-shared CC=clang FC=flang --prefix=/home/mylogin/mydir
make check && make install

Detailed instructions¶

You need a C compiler, such as gcc.

A fortran compiler, compliant with the ANSI Fortran 77 specifications, is required to compile the fortran-77/90/95 interface of the library.

A fortran compiler, compliant with the Fortran 2003 specifications, is required to compile the fortran-2003 interface of the library.

And you need a standard Unix make program, plus some other standard Unix utility programs.

Here are the detailed steps needed to install the library on Unix systems:

tar xzf calceph-3.5.5.tar.gz
cd calceph-3.5.5
./configure
Running configure might take a while. While running, it prints some messages telling which features it is checking for.

configure recognizes the following options to control how it operates.
--enable-fortran={yes|no}

Enable or disable the fortran-77 and fortran-2003 interface. The default is yes.

--enable-thread={yes|no}

Enable or disable the thread-safe version of the functions calceph_sopen() and calceph_scompute(), ... and concurrent access to the function calceph_compute(), .... The default is no.

--disable-shared

Disable shared library.

--disable-static

Disable static library.

--help

Print a summary of all of the options to configure, and exit.

--prefix= dir

Use dir as the installation prefix. See the command make install for the installation names.
The default compilers could be changed using the variable CC for C compiler and FC for the Fortran compiler. The default compiler flags could be changed using the variable CFLAGS for C compiler and FCFLAGS for the Fortran compiler.

Note

The option --enable-python... should not be used. They are reserved for the installation of the python interface.

make

This compiles the CALCEPH Library in the working directory.

make check

This will make sure that the CALCEPH Library was built correctly.

If you get error messages, please report them to inpop.imcce@obspm.fr (see Reporting bugs, for information on what to include in useful bug reports).

make install

This will copy the files calceph.h, calceph.mod and f90calceph.h to the directory /usr/local/include, the file libcalceph.a, libcalceph.so to the directory /usr/local/lib, and the documentations files to the directory /usr/local/doc/calceph/ (or if you passed the --prefix option to configure, using the prefix directory given as argument to --prefix instead of /usr/local). Note: you need write permissions on these directories.

Other make Targets

There are some other useful make targets:

clean

Delete all object files and archive files, but not the configuration files.

distclean

Delete all files not included in the distribution.

installnodoc

Same as install, except that the documentation is not installed.

uninstall

Delete all files copied by make install.

Windows system¶

Using the Microsoft Visual C++ compiler¶

You need the Microsoft Visual C++ compiler, such as cl.exe, and the Universal CRT SDK or a Windows SDK. A fortran compiler, compliant with the ANSI Fortran 77 specifications, is required to compile the fortran-77/90/95 interface of the library. A fortran compiler, compliant with the Fortran 2003 specifications, is required to compile the fortran-2003 interface of the library.

The "Universal CRT (C runtime) SDK" or a "Windows SDK" are now provided with the Microsoft Visual Studio. You should verify that "Universal CRT (C runtime) SDK" or a "Windows SDK" is selected in the "Visual Studio Installer".

If you use the C or Fortran interface, the steps are :

Expand the file calceph-3.5.5.tar.gz
Execute the command cmd.exe from the menu Start / Execute...

This will open a console window
cd dir\calceph-3.5.5

Go to the directory dir where CALCEPH Library has been expanded.
nmake /f Makefile.vc
This compiles CALCEPH Library in the working directory. This command line accepts several options :
- CC= xx
  
  specifies the name of the C compiler. The defaut value is cl.exe
- FC= xx
  
  specifies the name of the Fortran compiler. The defaut value is gfortran.exe
- F77FUNC= naming
  
  specifies the naming convention of the fortran 77 compiler.
  
  The possible value are: x, X, x##_ , X##_.
- ENABLEF2003={0|1}
  
  specifies if it must compile the fortran 2003 interface. The defaut value is 0.
- ENABLEF77={0|1}
  
  specifies if it must compile the fortran 77/90/95 interface. The defaut value is 0.
nmake /f Makefile.vc check
This will make sure that the CALCEPH Library was built correctly.

If you get error messages, please report them to inpop.imcce@obspm.fr (see Reporting bugs, for information on what to include in useful bug reports).

This command line accepts several options :
- CC= xx
  
  specifies the name of the C compiler. The defaut value is cl.exe
- FC= xx
  
  specifies the name of the Fortran compiler. The defaut value is gfortran.exe
- F77FUNC= naming
  
  specifies the naming convention of the fortran 77 compiler.
  
  The possible value are: x, X, x##_ , X##_.
- ENABLEF2003={0|1}
  
  specifies if it must compile the fortran 2003 interface. The defaut value is 0.
- ENABLEF77={0|1}
  
  specifies if it must compile the fortran 77/90/95 interface. The defaut value is 0.

nmake /f Makefile.vc install DESTDIR= dir

This will copy the file calceph.h, calceph.mod and f90calceph.h to the directory dir, the file libcalceph.lib to the directory dir \lib, the documentation files to the directory dir \doc. Note: you need write permissions on these directories.

This command line accepts several options :

CC= xx

specifies the name of the C compiler. The defaut value is cl.exe

FC= xx

specifies the name of the Fortran compiler. The defaut value is gfortran.exe

F77FUNC= naming

specifies the naming convention of the fortran 77 compiler.

The possible value are: x, X, x##_ , X##_.

ENABLEF2003={0|1}

specifies if it must compile the fortran 2003 interface. The defaut value is 0.

ENABLEF77={0|1}

specifies if it must compile the fortran 77/90/95 interface. The defaut value is 0.

Using the MinGW¶

You need a C compiler, such as gcc.exe.

A fortran compiler, compliant with the ANSI Fortran 77 specifications, is required to compile the fortran-77/90/95 interface of the library.

A fortran compiler, such as gfortran.exe, compliant with the Fortran 2003 specifications, is required to compile the fortran-2003 interface of the library.

The steps are :

Expand the file calceph-3.5.5.tar.gz
Execute the command MinGW Shell from the menu Start.

This will open a MinGW Shell console window.
cd dir\calceph-3.5.5

Go to the directory dir where CALCEPH Library has been expanded.
make -f Makefile.mingw
This compiles CALCEPH Library in the working directory.

This command line accepts several options :
- CC= xx
  
  specifies the name of the C compiler. The defaut value is gcc.exe
- FC= xx
  
  specifies the name of the Fortran compiler. The defaut value is gfortran.exe
- F77FUNC= naming
  
  specifies the naming convention of the fortran 77 compiler.
  
  The possible value are: x, X, x##_ , X##_.
- ENABLEF2003={0|1}
  
  specifies if it must compile the fortran 2003 interface. The defaut value is 0.
- ENABLEF77={0|1}
  
  specifies if it must compile the fortran 77/90/95 interface. The defaut value is 0.
make -f Makefile.mingw check
This will make sure that the CALCEPH Library was built correctly.

If you get error messages, please report them to inpop.imcce@obspm.fr (see Reporting bugs , for information on what to include in useful bug reports).

This command line accepts several options :
- CC= xx
  
  specifies the name of the C compiler. The defaut value is gcc.exe
- FC= xx
  
  specifies the name of the Fortran compiler. The defaut value is gfortran.exe
- F77FUNC= naming
  
  specifies the naming convention of the fortran 77 compiler.
  
  The possible value are: x, X, x##_ , X##_.
- ENABLEF2003={0|1}
  
  specifies if it must compile the fortran 2003 interface. The defaut value is 0.
- ENABLEF77={0|1}
  
  specifies if it must compile the fortran 77/90/95 interface. The defaut value is 0.
make -f Makefile.mingw install DESTDIR= dir

This will copy the file calceph.h, calceph.mod and f90calceph.h to the directory dir, the file libcalceph.lib to the directory dir \lib, the documentation files to the directory dir \doc.

Note

you need write permissions on these directories.

This command line accepts several options :

CC= xx

specifies the name of the C compiler. The defaut value is gcc.exe

FC= xx

specifies the name of the Fortran compiler. The defaut value is gfortran.exe

F77FUNC= naming

specifies the naming convention of the fortran 77 compiler.

The possible value are: x, X, x##_ , X##_.

ENABLEF2003={0|1}

specifies if it must compile the fortran 2003 interface. The defaut value is 0.

ENABLEF77={0|1}

specifies if it must compile the fortran 77/90/95 interface. The defaut value is 0.

Note

The option ...PYTHON... should not be used. They are reserved for the installation of the python interface.