links from Installation notes

Since the release v6p1 of the TELEMAC system we are confronting users and developers with two choices:

• A download of a zipped file, including the source code and the TELEMAC-MASCARET tree structure. This is the way it has always been done in the past. The principal disadvantage of this method is that updates have to be re-packaged, re-downloaded and re-installed in full.

In the download area of this website, you can choose the Sources: Zip menu, download the zipped file and extract its contents.

• A download through the SVN subversion system, with a more modern access to the source code and its various updates. The principal advantage of this method is that the sources code remains linked to the developers' main repository and that updates are just updates.

In the download area of this website, you can choose the Sources: SVN menu, which explain how to link to the newly extract its contents.

If you are a new user of the TELEMAC system or if you know about professional quality controlled source code management system such as SVN subversion already, it is recommended that you use the second downloading procedure as it much simpler than its zipped equivalent.

Once copied, zipped or untarred, or just checked out from the SVN repository, your TELEMAC directory (referenced here as ~root, see important note above) should contain the following sub-directories. Note that the directory structure used to be different prior to v6p3 (you can check the history of this wiki-page to get to the former structure definition).

_

– /sources : For all to-be-compiled codes of the TELEMAC-MASCARET system, this is the one place containing all source files, pseudo makefiles (cmdf), dictionary (dico) files or equivalent, …

note The following structure remains as-is unless a new code (dredgsim, etc.) is added to the system.

note Just like the utils sub-folder, each code sub-folder can include any number of sub-folder structure (easier to group and find what you are looking for).

note Version numbers is not part of the directory structure any more. This simplifies greatly the maintenance and traceability of the code through the SVN subversion system.

_

– /sources
– / … /artemis : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /dredgsim : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /mascaret : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /postel3d : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /sisyphe : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /stbtel : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /telemac2d : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /telemac3d : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /tomawac : ( .f .f90 .F .F90 + .cmdf + .dico )
– / … /utils : Contains all other dependent and pre- and post-processors
– / … / … /bief : ( .f .f90 .F .F90 )
– / … / … /damocles : ( .f .f90 .F .F90 )
– / … / … /partel : Partel and other related ( .f .f90 .F .F90 + .cmdf )
– / … / … /gretel : Gretel and other related ( .f .f90 .F .F90 + .cmdf )
– / … / … /parallel : Wrapper on all the calls to mpi, whether void or implemented ( .f .f90 .F .F90 )
– / … / … /special : Contains additional sources ( .f .f90 .F .F90 )

_

– /scripts : For all no-to-be-compiled source files for scripts to run, compile, etc. the main codes

note Each sub-folder can include any number of sub-folder structures (easier to group and find what you are looking for). _

– / … /python27 : Useful python scripts (content of /pytel, already includes sub-folders)
– / … /perl5 : Useful perl scripts (current content of /bin/*.pl and /bin/*.bat and other shell scripts)
– / … /cluster : EDF's specific mix of perl and python scripts for launch on HPC (current content of /bin/cluster, although to be replaced eventually by python-only scripts)

_

– /configs : Contains all user defined and examples of *.cfg and systel.ini files.

note The environment variable SYSTELUSE defines where the current file points to, and it can be anywhere on the user's system.

_

– /optionals : Optional external and API libraries

note May include source files but will have to be compiled separately before or after linking with compilation and use of the main codes _

– / … /addons :
– / … / … /conviee : ( current content of *@/bin/conviee@*, although to be replaced by python scripts )
– / … / … /diffsel_dir : ( current content of *@/bin/diffsel_dir@*, although to be replaced by python scripts )
– / … / … /techplot : ( .c .cpp .cxx .h .f .f90 .F .F90 + .xml + many others file necessary for the compilation )
– / … / … /paraview : ( .c .cpp .cxx .h .f .f90 .F .F90 + .xml + many others file necessary for the compilation )
– / … /mascaretapi : Sources and other directories of the API of the MASCARET code.
– / … /metis-5.0.2
– / … /parmetis
– / … /scotch
– / … /med

_

– /builds : Contains one or more packages of program binaries and pre-compiled libraries of one or several main codes.

note By default this folder is empty and filled when compiling one or more configurations

note The sub-folders /bin, /lib, include a mirror image of the subdirectory structure of the /sources except only for these directory the specific configuration does not need.

_

– / … /“config-x” : with “config-x” = a specific name defined as a configuration name (version, compiler, options, …) from the systel.cfg file
– / … / … /bin : all the exe files of the config + pytel
– / … / … /lib : all the .o .obj and .lib .a and .mod
– / … / … systel.cfg : the one specific configuration “config-x”
– / … /“config-y” : with “config-y” = another specific name defined as another configuration name (version, compiler, options, …) from the systel.cfg file
– / … / … /bin : all the exe files + python
– / … / … /lib : all the .o .obj and .lib .a and .mod
– / … / … systel.cfg : the one specific configuration “config-y”

_

– /examples : Contains validation test cases with a sub-folder for each modules.

note This groups all validation sub-folders currently within each code into one separate directory. _

– / … /artemis :
– / … / … /creocean
– / … / … /bj78
– / … / … /
– / … /mascaret :
– / … /postel3d :
– / … /sisyphe :
– / … / … /bosse-analyt
– / … / … /canal_solid_discharge_inflow
– / … / … /…
– / … /stbtel :
– / … /telemac2d :
– / … / … /bumpflu
– / … / … /bumpcri
– / … / … /…
– / … /telemac3d :
– / … / … /canal
– / … / … /solit
– / … / … /…
– / … /tomawac :
– / … / … /bottom_friction
– / … / … /turning_wind
– / … / … /

README.txt : a few standard information like the license and so on but mainly redirecting to the opentelemac.org website.

It is critical that the TELEMAC-SYSTEM system be stored within a directory path with no spaces (i.e. not in “Program Files” for instance). For instance, under c:\opentelemac\v7p1 on MS Windows operating system or /home/user/opentelemac/v7p1 on Linux operating systems. This path will be referenced as ”~root” in the rest of this documentation.