Home Documentation Using R.I.N.G.S. Installing the R.I.N.G.S. code

Installing the R.I.N.G.S. code

E-mail Print

In order to install / compile the R.I.N.G.S. code:

  1. Download the R.I.N.G.S. code distribution package on your computer
  2. Open the R.I.N.G.S. code distribution package and change directory to the 'rings-code' directory
  3. Configure the R.I.N.G.S. code simply using the the 'configure' script:
    ]$ ./configure
  4. Then build and install the R.I.N.G.S. code:
    ]$ make
    ]$ make install

Detailed instructions:

  1. Download the R.I.N.G.S. code distribution package on your computer (link will be added soon)
  2. Open the R.I.N.G.S. code distribution package and change directory to the 'rings-code' directory:
    ]$ tar -jxf rings-code.tar.bz2
    or   ]$ tar -zxf rings-code.tar.gz
    (depending on the package which has been downloaded)    
    ]$ ls -l

    total 4,0K
    drwxrwxr-x 4 user user-group 4,0K janv. 31 19:43 rings-code
    ]$ cd rings-code
  3. Configure the R.I.N.G.S. code simply using the the 'configure' script:
    ]$ ./configure
    • Useful 'configure' options:
      • FC
      • FCFLAGS
      • --without-mpi
      • --with-mpi
      • MPIFC
      • LDFLAGS
      • --prefix=
      => specify the Fortran90 compiler that will be use to compile the R.I.N.G.S. code
      => specify the Fortran90 compilation options ie. Fortran90 FLAGS that will be use to build the R.I.N.G.S. code *
      => compile the serial version of the R.I.N.G.S. code (this is the default option)
      => compile the MPI version of the R.I.NG.S. code **
      => specify the Fortran90/MPI compiler that will be use to compile the R.I.N.G.S. code (if in a nonstandard directory)
      => specify linker flags, e.g. -L<MY_LIBRARY_DIRECTORY> if you have MPI libraries in a nonstandard directory <lib dir>  **
      => relocate the installation directory (default directory is '/usr/local/bin')
    • Example 1:
      ]$ ./configure MPIFC=mpif90 FCFLAGS="-O3 -mtune=core2" --with-mpi --prefix=/home/MY_ACCOUNT/bin
      Then the "mpif90" compiler (MPI compiler) will be used to build the MPI version of the code using the compilation options "-O3 -mtune=core2" (optimization for Core2duo processors).
      Finally the executable file named 'rings-code' will be relocated in the directory named '/home/MY_ACCOUNT/bin'
    • Example 2:
      ]$ ./configure FC=ifort FCFLAGS="-O3 -mtune=core2"
      Then the "ifort" compiler (Intel fortran) will be used to build the serial version of the code using the compilation options "-O3 -mtune=core2" (optimization for Core2duo processors).
      Finally the executable file named 'rings-code' will installed in the standard directory '/usr/local/bin'
    • Example 3:
      ]$ ./configure FC=gfortran FCFLAGS="-DOSX -cpp -O3 -mtune=nocona -march=native"
      Then the "gfortran" compiler (GNU fortran) will be used to build the serial version of the code using the compilation options "-DOSX -cpp -O3 -mcpu=nocona"  for MacOSX plateforms *** and optimizations for improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE, SSE2 and SSE3 instruction set support. 
      Finally the executable file named 'rings-code' will installed in the standard directory '/usr/local/bin'
  4. Then build and install the R.I.N.G.S. code:
    ]$ make
    ]$ make install

* Please notice that the compilation options given by the "FCFLAGS" option depend on the compiler used to build the code.

** The build of the MPI version of the R.I.N.G.S. code (using the 'configure' option "--with-mpi" ) includes a check of the presence of the MPI library. If for some reason the MPI library does not appear to be in a standard directory (given by the $LD_LIBRARY_PATH environment variable) then it is mandatory for the configuration and the compilation processes to give the path of the MPI library using the "LDFLAGS" option to the configure script.

*** To build the R.I.N.G.S. for MacOSX plateforms it is required both to define the OSX variable (-DOSX) and to tell the compiler to call the pre-processor (-cpp), at the configure stage.

Last Updated on Sunday, 05 October 2014 06:13  

 Latest version

RINGS Last version logo
A new version of the RINGS code has been released !

 Mailing List

Mailing list
Join the RINGS code mailing list !

 Hosted by

Get rings-code at SourceForge.net. Fast, secure and Free Open Source software downloads