sunfluidh:sunfluidh_install
Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédenteProchaine révisionLes deux révisions suivantes | ||
sunfluidh:sunfluidh_install [2016/01/19 16:30] – yann | sunfluidh:sunfluidh_install [2016/01/19 18:23] – yann | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
- | ==== SUNFLUIDH INSTALL | + | ==== SUNFLUIDH INSTALL |
----- | ----- | ||
+ | |||
+ | === Download the sunfluidh project === | ||
The sunfluidh project is placed on the forge and is handled with the version control system [[ http:// | The sunfluidh project is placed on the forge and is handled with the version control system [[ http:// | ||
In order to install sunfluidh on your computer, please, follow these steps : | In order to install sunfluidh on your computer, please, follow these steps : | ||
* Ensure you get the required authorization to download the sunfluidh project with svn from the forge (contact AMIC for that) | * Ensure you get the required authorization to download the sunfluidh project with svn from the forge (contact AMIC for that) | ||
- | * Define on your computer a directory to receipt the sunfluidh project (SUNFLUIDH for instance) | + | * Define on your computer a directory to receipt the sunfluidh project (~/SUNFLUIDH for instance) |
* Go to the directory SUNFLUIDH | * Go to the directory SUNFLUIDH | ||
- | * run the next command : \\ svn co --username your_login https:// | + | * run the next command : \\ svn co --username your_login https:// |
- | * | + | |
+ | === Setup of the project === | ||
+ | |||
+ | In the directory " | ||
+ | * DOC : It contains all documents related to the numerical methods implemented in the code (in french at present) | ||
+ | * DATA : It contains different data files : | ||
+ | * different tutorial data files in order to test the code (input_xxxx.dat). These files must be copied in the sunfluidh data file named input3d.dat in order to be used. | ||
+ | * different shell scripts in order to run the code in batch on various type of computers (local cluster, IDRIS computers). their names start with " | ||
+ | * A directory .../ | ||
+ | * SOURCES : This directory contains all the source files needed to compile the code. These sources files are compiled by means of the makefile file. | ||
+ | |||
+ | === Compilation procedure === | ||
+ | |||
+ | In order to compile the code on your computer, please, follow these steps : | ||
+ | |||
+ | * Go to the directory " | ||
+ | * Open the file " | ||
+ | * Run the command " | ||
+ | |||
+ | === How do start to work === | ||
+ | |||
+ | Before starting to work with the code, find here some advices : | ||
+ | |||
+ | We suppose here your operating system is __UNIX, LINUX or BSD__ and your shell is __the BASH__. | ||
+ | |||
+ | * Create a local working directory in your home directory (for instance " | ||
+ | * Create your own data file for sunfluidh in your working directory. This data file must be named " | ||
+ | * Place the executable file (sunfluidh.x) in your working directory and run it : ./ | ||
+ | |||
+ | |||
+ | It is often better to create a specific local directory in order to store your executable files rather than moving them from the compilation directory to the working directory. This prevents against the harmful overgrowth of executable files while more and more working directories are created over the time. For that : | ||
+ | * Create a specific directory in your home directory in order to store your own executable files (for instance " | ||
+ | * Move your executable files (here just sunfluidh.x) from the compilation directory to " | ||
+ | * In order to executable files can be ran anywhere in your working space, you must inform your computer system where they are stored : | ||
+ | * In your local root directory (your home), open the system file named .profile (or .bashrc, or .bashrc_profile this depends on your operating system) and write the command line : \\ export PATH=" | ||
sunfluidh/sunfluidh_install.txt · Dernière modification : 2023/07/10 10:30 de yann