diff --git a/README.md b/README.md index 108a1ec17c2a9778c8bc22b057f6cd066ef6709c..f92aaf2e17f3ae9e3cb2d106dc7fd4e43a4a95c9 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,76 @@ Pour réaliser le projet vous aurez besoin de cette [documentation](doc-projet.p **Attention**, seuls les fichiers dans le répertoire `src` sont à modifier ! -## Utilisation de `julia`dans les salles d'enseignement -* Pour lancer `julia` sur les machines enseignement il faut dans votre fichier `.bashrc` initialiser la variable d'environnement de `julia` `JULIA_DEPOT_PATH` et ajouter à la variable `PATH` l'endroit où se trouve `julia`. Il faut pour cela ajouter les lignes suivantes : -`JULIA_DEPOT_PATH="/mnt/n7fs/cimi/.julia"` -`export JULIA_DEPOT_PATH` -`export PATH="/mnt/n7fs/cimi/julia-1.8.2/bin":$PATH` +## Utilisation de `julia` dans les salles d'enseignement -* Pour pouvoir utiliser les notebooks, il faudra alors taper la commande ` jupyter-notebook` +### Via Jupyter notebook +La première étape consiste à ajouter dans le path, le chemin contenant l'exécutable Julia. Pour cela, ajouter dans le fichier `~/.bashrc` la ligne suivante. + +```bash +export PATH="/home/ocots/Public/bin":$PATH +``` + +Ensuite, ouvrez un terminal et exécuter la commande `julia`. Cela doit ouvrir une version `1.8.2` de Julia. Pour utiliser `Jupyter notebook` +il faut au préalable installer le noyau Julia. Pour cela, exécuter les commandes : + +```julia +using Pkg +Pkg.build("IJulia") +``` + +Maintenant, il est possible d'ouvrir Jupyter pour exécuter des notebooks Julia. Pour cela, toujours dans `Julia` faites : + +```julia +using IJulia +notebook() +``` + +### Via VS Code + +Si vous désirez utiliser VS Code, il vous faudra installer certains packages sur votre compte personnel ce qui peut vous faire dépasser votre quota. +En principe, pour ce projet, il y a très peu de packages supplémentaires à installer. + +1. Pour utiliser des notebooks Julia dans VS Code, il faut tout d'abord installer les extensions [Julia](https://marketplace.visualstudio.com/items?itemName=julialang.language-julia) et [Jupyter](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) dans `VS Code`. + +2. Il faut ensuite donner le chemin de l'exécutable Julia. Pour cela, ouvrir les préférences `File -> Preferences -> Settings` et faire la recherche `julia path`. Dans l'option `Julia: Executable Path`, écrire + +```bash +/home/ocots/Public/bin/julia_vs_code +``` + +3. Fermer et réouvrir `VS Code`. + +4. Ouvrir le dossier du projet et exécuter (SHIFT + ENTER ou CTRL + ENTER) la première cellule de code du fichier `src/algo_newton.ipynb`. Vous devez alors sélectionner le code `Julia` qui sera utilisé, choisissez la version `1.8.2`. + +Attention, si certains `using` ne fonctionnent pas, c'est parce que vous devez ajouter des packages. Il faudra alors faire les commandes suivantes dans +n'importe quelle cellule du notebook, on appelle `pkg-name`, le nom du package à installer. + +```julia +using Pkg +Pkg.add("pkg-name") +``` + +## Installation de `julia` sur une machine personnelle + +1. Installer [Julia](https://julialang.org/downloads/) +2. Ouvrir Julia +3. Installer le noyau julia dans Jupyter : + +Pour utiliser `Jupyter notebook` il faut au préalable installer le noyau Julia. Pour cela, exécuter les commandes : + +```julia +using Pkg +Pkg.add("IJulia") +Pkg.build("IJulia") +``` + +Maintenant, il est possible d'ouvrir Jupyter pour exécuter des notebooks Julia. +Pour cela, toujours dans `Julia` faites : + +```julia +using IJulia +notebook() +``` + +Il vous sera peut-être demandé d'installer Jupyter. Suivez alors les instructions.