Retour au menu principal

## Compatibilité

Atomsk est conçu pour fonctionner sur les environnements Unix/Linux et Microsoft® Windows®.

## Disponibilité

Il est recommandé de télécharger Atomsk depuis la page officielle : https://atomsk.univ-lille.fr/fr/

Selon votre préférence, vous pouvez télécharger l'exécutable pour votre plate-forme, ou bien télécharger le code source et le compiler comme expliqué ci-dessous.

## Version exécutable

Le plus simple pour commencer à utiliser Atomsk est de télécharger la version exécutable pour votre plate-forme depuis cette page. Cette version binaire statique est prête à l'emploi et devrait s'exécuter sur votre machine sans aucune autre manipulation.

Les versions GNU/Linux de Atomsk sont fournies avec un script d'installation nommé "install.sh". Si vous choisissez d'utiliser ce script, il doit être exécuté en tant que super-utilisateur (ou avec sudo). Le programme sera installé dans le dossier /usr/local/bin/ par défaut.

## Compilation depuis le code source

Si vous ne souhaitez pas utiliser la version binaire statique d'Atomsk, vous pouvez télécharger le code source et le compiler vous-même. La compilation requiert que la bibliothèque LAPACK soit installée sur votre système.

Le code source du programme est accompagné d'un Makefile. Pour un résumé des cibles possibles, entrez le répertoire `src` et tapez "`make`" ou "`make help`". Pour compiler le programme, tapez :

`make atomsk`

Si votre machine possède plusieurs processeurs ou un processeur multi-cœurs alors il est possible d'accélérer la procédure en activant la compilation en parallèle grâce à l'option `--jobs` (ou `-j`). Par exemple pour utiliser cinq processus de compilation :

`make -j5 atomsk`

Notez que si le nombre de processus est supérieur au nombre de cœurs disponibles sur votre machine alors la compilation ne sera pas plus rapide.

Si la commande ci-dessus ne fonctionne pas alors vérifiez les points suivants. Premièrement le programme GNU Make doit être installé sur votre ordinateur. Deuxièmement, par défaut le Makefile fait appel au compilateur GNU Fortran (`gfortran`), il est donc recommandé qu'il soit installé.

Ensuite, vérifiez que la bibliothèque LAPACK est installée sur votre système. Le chemin vers la bibliothèque doit être définie par la variable `LAPACK`. Sur les systèmes UNIX/Linux, si LAPACK est installé par le système alors il suffit d'utiliser "`LAPACK=-llapack`". Sinon (par ex. si vous avez compilé LAPACK dans votre dossier personnel), utilisez le chemin complet vers la bibliothèque de la manière suivante : "`LAPACK=-L/chemin/vers/la/bibliothèque -llapack`". Les utilisateurs de la bibliothèque Intel® MKL sont invités à se référer à la documentation Intel®. Sur les systèmes Microsoft® Windows®, une version de la bibliothèque LAPACK est aussi requise (le `Makefile.windows` fourni avec le programme donne des indications pour obtenir LAPACK pour Windows, voir aussi cette page et/ou cette page). Notez que l'auteur de Atomsk ne fournira pas de support pour LAPACK. Si vous rencontrez des difficultés pour obtenir ou compiler LAPACK sur votre système, tournez-vous vers la communauté de LAPACK.

Pour personnaliser la compilation pour votre machine, veuillez ne pas éditer le Makefile principal (c'est-à-dire le fichier `Makefile`). À la place il est recommandé de créer un Makefile séparé, appelé par exemple `Makefile.truc`, que vous pourrez ré-utiliser à chaque fois que vous aurez besoin de compiler Atomsk. Ce `Makefile.truc` personnalisé peut contenir seulement les variables nécessaires (`FORTRAN`, `LAPACK`, et au besoin `FFLAGS` et `INSTPATH`), et finir par la mention "`include Makefile`". Vous pouvez prendre exemple sur les Makefiles alternatifs `Makefile.g95` ou `Makefile.ifort` fournis avec le programme. Pour utiliser votre Makefile tapez alors :

`make -f Makefile.truc atomsk`

Notez que le programme utilise certaines procédures qui n'existent qu'en Fortran 95, assurez-vous donc d'utiliser un compilateur compatible avec cette norme. Jusqu'ici le programme a été testé et compile correctement avec les compilateurs suivants :

GNU/Linux:

- GNU Fortran (gfortran) version 9 ou supérieure
- Intel® Fortran (ifort) 10.1, 11.0, 12.0, 13.0, 14.0

Microsoft® Windows®:

- MinGW-gfortran 1.0

Afin d'optimiser le programme vous pouvez également modifier les options de compilation, pour les ajuster à l'architecture de votre machine, en modifiant la variable `FFLAGS`. Notez que `-O3` peut introduire des optimisations très agressives pouvant compromettre le comportement du programme, un niveau d'optimisation `-O2` est donc recommandé. Lors de la compilation dans un environnement Microsoft® Windows® l'option `-DWINDOWS` est requise.

Le Makefile par défaut active OpenMP, ce qui signifie que certaines parties du code pourront s'exécuter sur plusieurs cœurs en parallèle. Pour activer OpenMP, le Makefile doit contenir la ligne "`OPENMP=-DOPENMP -openmp`". Le dernier mot-clé "`-openmp`" active OpenMP pour le compilateur GNU Fortran, et doit être remplacé par le mot-clé approprié si un autre compilateur est utilisé. Pour désactiver OpenMP, commentez simplement cette ligne.

Si la compilation échoue et retourne une erreur, regardez d'abord la FAQ, et ensuite demandez de l'aide à votre administrateur système. Si vous pensez que l'erreur est due à un bug dans le code source du programme, vous pouvez envoyer un rapport de bug à l'auteur. Merci de spécifier quel module a causé l'erreur lors de la compilation.

Une fois la compilation terminée un fichier exécutable est créé, appelé "atomsk" sur les systèmes UNIX/Linux et macOS, ou bien "`atomsk.exe`" sur les systèmes Microsoft® Windows®. Vous pouvez copier cet exécutable dans le répertoire de votre choix afin de l'exécuter.

Le `Makefile` permet également de faciliter l'installation por tous les utilisateurs du système sur les systèmes Linux (voir ci-dessous).

## Installation sur les systèmes Linux

Une fois la compilation terminée, si vous avez les droits administrateur sur votre machine vous pouvez taper :

`make install`

Par défaut le programme Atomsk sera copié dans le répertoire /usr/local/bin, de sorte que n'importe quel utilisateur du système puisse l'exécuter. Les outils compagnons seront aussi copiés dans ce répertoire et rendus exécutables. La documentation html sera copiée vers le répertore /usr/local/share/doc/atomsk (copiez cette adresse dans un navigateur Web pour accéder à la documentation). La page de manuel sera copiée dans /usr/local/share/man/man1/ et pourra ếtre lur en tapant "`man atomsk`". Ces chemins par défaut peuvent êtrre changés en configurant les variables `INSTPATH`, `DOCPATH` et `MANPATH` dans votre Makefile personnalisé.

Vous pouvez également utiliser la commande "`make all`" avec les droits administrateurs pour compiler et installer le programme en une seule commande (ceci est équivalent à "`make atomsk && make install && make clean`").

Si vous n'avez pas les droits administrateurs sur votre machine, vous pouvez exécuter le programme en tapant son chemin d'accès complet ; ajouter l'emplacement du programme à votre variable système `PATH` ; ou bien créer un alias.

## Désinstallation sur les systèmes Linux

Si vous aviez installé le programme avec la commande `make install`, alors vous pouvez le désinstaller aussi facilement en allant dans le répertoire `src` et en tapant (avec les droits administrateur) :

`make uninstall`

Ceci supprimera le programme atomsk ainsi que toute la documentation de leurs chemins respectifs (voir la section Installation ci-dessus).

Si vous n'aviez pas installé le programme avec la commande `make install`, supprimez entièrement le répertoire atomsk de votre disque dur. Au besoin, supprimez aussi ce chemin de votre variable système `PATH` et/ou les alias.

## Créer une archive du programme

Il est possible de créer une archive du programme en entrant dans le dossier `/src/` et en tapant :

`make tar`

Par défaut l'archive sera créée dans le dossier parent

Retour au menu principal