Decompress and unarchive the Ariane package
Hello and welcome to this module.
In the previous module, we saw
how to download the source code of the Ariane package.
In this module we will learn
how to decompress and unarchive the Ariane package
and we will discover its tree of directories and files.
We will need an X terminal
which I will open here by clicking on the 'Terminal' icon.
I'll just reposition it to make it easier to read.
We'll use a number of commands
that you should already know.
'cd' to change the directory,
'ls' to list the contents of a directory,
'more' to see the contents of a text file,
'tar' to unpack and unarchive the Ariane package.
For more details on commands,
you can type '--help'
or 'man' to get the manual for a command, e.g. 'man tar'.
I won't go into more detail,
you can find more information on the internet.
I go to the 'HOME' directory by typing 'cd $HOME'.
In the previous video we created a directory called 'Ariane',
which should be in 'HOME'.
So I'll change directory,
to go to the 'Ariane' directory.
If you don't have this directory, please review the previous module.
If I list the contents of this directory,
I should find the Ariane package downloaded from the website.
Here we have the Ariane package,
version 2.3.0_02
in its compressed form, with a .gz extension
and archived with a .tar extension.
We are going to see how to decompress and unarchive this file.
We will use the 'tar' command,
with the options xzvf.
You can find more details on these options online.
We then type the full name of the file
and run the command.
We see the contents of the package scrolling on the screen.
This is very fast.
Let’s look at this content in detail.
Now if I list the contents
of the 'Ariane' directory, I see
that the Ariane package is still there,
but there is also a new directory
whose contents we will look at.
I use the 'Change Directory' command (cd)
to go into this directory.
I display the contents of the directory
using the 'ls' command and some options.
We have a number of files
and a number of directories.
I won't go into the details of all the files because
some of them are intended only for the software developer:
e.g. Makefile.am, configure.ac, aclocal.m4, Makefile.in
or the 'confdb’ directory, which is dedicated to software development.
If you want more details on packages
for Linux distributions,
I suggest you visit the GNU web page,
which details all these packages very well
with all the information needed to create and use them.
The GNU packages were my basis
when creating the Ariane package.
For such packages, you need
a number of files where we put some information
and a directory tree
in order to compile and install the program.
You can find more details on the website.
Let's quickly detail some of the files in this directory.
'ChangeLog' shows the evolution of the software.
'AUTHORS' lists the authors of the Ariane package,
the 'more' command shows us its content.
Bruno Blanke is the creator of the Ariane application,
and Nicolas Grima (yours truly) works on development and maintenance.
You can contact us via our email addresses in 'AUTHORS'.
The 'README' file essentially contains
the URL of the Ariane web page
and links to the 'INSTALL' file,
which allows you to compile and install Ariane.
Let's display the list of files again.
The next file is 'INSTALL'.
Let's look at it quickly.
This file contains instructions.
This package follows the GNU package model and respects its standards.
Following these standards simplifies compilation and installation.
The 'INSTALL' file, inspired by GNU,
tells you in detail how to proceed.
We won't go into that today.
This file will be the subject of another module.
The 'Makefile.am' file we won't look at.
The 'COPYING' file contains information
about the license used for the development of Ariane.
This is free software.
You can use and modify it as you wish,
as long as you mention the origin of the package.
The CeCILL licence was developed in France
and is very similar to the GNU license,
but adapted for French law.
See www.cecill.info for more details.
Let's display the list of files again.
The 'NEWS' file contains information
about the evolution of Ariane.
'configure.ac', 'aclocal.m4' and 'Makefile.in' are only for developers.
The 'configure' file is an executable file.
This file is very important because it allows
the compilation and installation of Ariane.
Then, we have four directories.
The 'src' directory contains the software source code.
Let's look at the contents of this directory.
There are two files for developers
and two directories where the source code is located,
as well as pre- and post-processing tools.
Let's move to the 'ariane' directory.
If we list its contents,
we see a series of files with the extension '.f90'.
The Ariane application is written in Fortran,
a 'modern' version of Fortran, Fortran 90,
with standards from 2003 and 2008.
If you want to modify or upgrade the Ariane code,
you will need to know some Fortran.
Here, for example, we have
the main file: 'ariane.f90'
and all the modules it depends on.
We will see later that it is sometimes necessary
to make changes in this Ariane source directory.
The 'tools' directory contains pre- and post-processing tools.
I won't go into detail today.
Let's go back and read the 'Ariane-2.3.0_02' directory.
We have a directory with supporting documents.
There we have two directories: 'manuals',
which contains the user manuals for the Ariane program,
and 'figs', which contains figures
that we will be using in later modules.
These allow us to represent
how we place particles in time
in the Ariane program,
or how we place them in our numerical model.
Now I'm going back to the previous directory
We'll have a quick look at
the 'examples’ directory, which gives
a number of example models and configurations.
We have several directories
which contain the necessary files
for setting up Ariane experiments.
One of these files is called 'Namelist'.
As you learned in the theoretical part of Ariane,
Ariane works in two modes: quantitative and qualitative.
Here there are examples for both modes.
The 'data' directory provides a very small dataset
of ocean circulation models
in case you have no data available.
This will let you have fun and discover the program
if you don't have any data from an ocean model.
We have more specific examples
for the regional circulation model 'ROMS'
or now 'CROCO'.
We also have some more specific examples
for the 'NEMO' or 'NEMO-OPA' model.
We also have some tools
or 'modules' to do graphic post-processing
either in IDL or in Matlab.
We are also developing modules for Python
but these are not finished yet.
We also have some shell scripts that allow us
to do pre-processing or post-processing.
We will look at this in other modules.
So, in this video we have seen how to
decompress and unarchive the Ariane package.
We have examined the tree of directories and files.
In a later video you will learn how to compile
and install the Ariane program.
Thank you!