Difference between revisions of "Quick Install and Run"
| Line 5: | Line 5: | ||
The GCM source code is in Fortran. One thus needs a Fortran compiler to build (compile) the executable. | The GCM source code is in Fortran. One thus needs a Fortran compiler to build (compile) the executable. | ||
The most easily available one (on Linux) is gfortran and examples discussed here will assume it is the one used. | The most easily available one (on Linux) is gfortran and examples discussed here will assume it is the one used. | ||
| + | You can check that you indeed have a gfortran compiler at hand with the following Bash command: | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | which gfortran | ||
| + | </syntaxhighlight> | ||
| + | which should return something like | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | /usr/bin/gfortran | ||
| + | </syntaxhighlight> | ||
=== Subversion === | === Subversion === | ||
| − | The source code is managed using subversion (svn), which you'll need to download or update your copy. | + | The source code is managed using subversion (svn), which you'll need to download or update your copy. Leaving aside the subtleties of svn and code organization for now, downloading the code amounts to doing the following: |
| + | <syntaxhighlight lang="bash"> | ||
| + | svn checkout http://svn.lmd.jussieu.fr/Planeto/trunk --depth empty | ||
| + | cd trunk | ||
| + | svn update LMDZ.COMMON LMDZ.GENERIC | ||
| + | </syntaxhighlight> | ||
As a side note: the source code that will be fetched by svn can also be browsed online here: https://trac.lmd.jussieu.fr/Planeto | As a side note: the source code that will be fetched by svn can also be browsed online here: https://trac.lmd.jussieu.fr/Planeto | ||
=== FCM === | === FCM === | ||
| + | The FCM (Flexible Configuration Management) tool is a suite of perl scripts to help building and managing codes. We use a slightly modified version which can be obtained using subversion (svn). Ideally you'll want to download it somewhere on your computer once in for all. To do this: | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | svn checkout http://forge.ipsl.jussieu.fr/fcm/svn/PATCHED/FCM_V1.2 | ||
| + | </syntaxhighlight> | ||
| + | You'll then need to add the resulting FCM_V1.2/bin to your PATH environment variable so that the command "fcm" may be used from anywhere on your machine. e.g. by adding the following line in your .bashrc: | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | export PATH=$PATH:$HOME/FCM_V1.2/bin | ||
| + | </syntaxhighlight> | ||
| + | Assuming here that the downloaded FCM_V1.2 directory is in your home ($HOME) directory. Adapt accordingly if not. | ||
| − | + | === the NetCDF library === | |
| − | + | The GCM reads and writes input and output files in NetCDF format. Therefore a NetCDF library must be available. As this library is not quite standard you'll probably have to install it yourself on your system. You can use the following home-made "install_netcdf4_hdf5_seq.bash" script to do so: | |
| + | <syntaxhighlight lang="bash"> | ||
| + | wget -nv --no-check-certificate http://www.lmd.jussieu.fr/~lmdz/pub/import/install_netcdf4_hdf5_seq.bash | ||
| + | chmod u=rwx install_netcdf4_hdf5_seq.bash | ||
| + | ./install_netcdf4_hdf5_seq.bash > netcdf.log 2>&1 | ||
| + | </syntaxhighlight> | ||
| + | Compiling the library and dependencies takes a while (more than 10 minutes; be patient). | ||
| + | Once it is done do check file netcdf.log to verify all went well. | ||
| + | You may want to also add its "bin" directory to your PATH environment variable by adding in your .bashrc a line of: | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | export PATH=$PATH:$HOME/netcdf/bin | ||
| + | </syntaxhighlight> | ||
| + | Assuming here that you have run the "install_netcdf4_hdf5_seq.bash" script in a "netcdf" subdirectory of your home directory. Adapt accordingly if not. | ||
| + | |||
| + | |||
| + | As a side note: The NetCDF library provides a very simple command line tool (ncdump) to inspect the contents of NetCDF files, but you'll need more advanced visualization tools (e.g. ncview, Ferret, Panoply, etc. seem further down this page in the "Checking the Results" section). | ||
| + | |||
| + | === the IOIPSL library === | ||
TO BE COMPLETED | TO BE COMPLETED | ||
Revision as of 10:14, 29 April 2022
Contents
Prerequisites:Tools and Libraries
In order to use (i.e. compile and run) the GCM, one needs to have some tools and installed libraries at hand. We list below a (minimal) set that you should check that is available and/or that you'll need to first install on your machine. By the way we also assume you're on a Linux OS.
Fortran compiler
The GCM source code is in Fortran. One thus needs a Fortran compiler to build (compile) the executable. The most easily available one (on Linux) is gfortran and examples discussed here will assume it is the one used. You can check that you indeed have a gfortran compiler at hand with the following Bash command:
which gfortran
which should return something like
/usr/bin/gfortran
Subversion
The source code is managed using subversion (svn), which you'll need to download or update your copy. Leaving aside the subtleties of svn and code organization for now, downloading the code amounts to doing the following:
svn checkout http://svn.lmd.jussieu.fr/Planeto/trunk --depth empty
cd trunk
svn update LMDZ.COMMON LMDZ.GENERIC
As a side note: the source code that will be fetched by svn can also be browsed online here: https://trac.lmd.jussieu.fr/Planeto
FCM
The FCM (Flexible Configuration Management) tool is a suite of perl scripts to help building and managing codes. We use a slightly modified version which can be obtained using subversion (svn). Ideally you'll want to download it somewhere on your computer once in for all. To do this:
svn checkout http://forge.ipsl.jussieu.fr/fcm/svn/PATCHED/FCM_V1.2
You'll then need to add the resulting FCM_V1.2/bin to your PATH environment variable so that the command "fcm" may be used from anywhere on your machine. e.g. by adding the following line in your .bashrc:
export PATH=$PATH:$HOME/FCM_V1.2/bin
Assuming here that the downloaded FCM_V1.2 directory is in your home ($HOME) directory. Adapt accordingly if not.
the NetCDF library
The GCM reads and writes input and output files in NetCDF format. Therefore a NetCDF library must be available. As this library is not quite standard you'll probably have to install it yourself on your system. You can use the following home-made "install_netcdf4_hdf5_seq.bash" script to do so:
wget -nv --no-check-certificate http://www.lmd.jussieu.fr/~lmdz/pub/import/install_netcdf4_hdf5_seq.bash
chmod u=rwx install_netcdf4_hdf5_seq.bash
./install_netcdf4_hdf5_seq.bash > netcdf.log 2>&1
Compiling the library and dependencies takes a while (more than 10 minutes; be patient). Once it is done do check file netcdf.log to verify all went well. You may want to also add its "bin" directory to your PATH environment variable by adding in your .bashrc a line of:
export PATH=$PATH:$HOME/netcdf/bin
Assuming here that you have run the "install_netcdf4_hdf5_seq.bash" script in a "netcdf" subdirectory of your home directory. Adapt accordingly if not.
As a side note: The NetCDF library provides a very simple command line tool (ncdump) to inspect the contents of NetCDF files, but you'll need more advanced visualization tools (e.g. ncview, Ferret, Panoply, etc. seem further down this page in the "Checking the Results" section).
the IOIPSL library
TO BE COMPLETED
Data
- datadir + starts + other GCM data for test case early Mars (desert planet with a CO2 atmosphere)
TO BE COMPLETED
BWAAAA
Compiling
- prepare and explain arch files
- compiling a test case (early Mars)
TO BE COMPLETED
Running
- run your first simulation
TO BE COMPLETED
Checking the Results
- everything is cool in the .out file
- tools to visualize the produced diagfi.nc file: panoply, ncview, paraview, etc.
TO BE COMPLETED
