From 01bbe35af0ea7d4b30181f822195bcc7ca87f04f Mon Sep 17 00:00:00 2001 From: gergaud Date: Sat, 7 Nov 2020 16:36:51 +0100 Subject: [PATCH] maj doc --- docs/make.jl | 2 +- docs/src/index.md | 9 +++++++-- docs/src/mise_en_place.md | 2 +- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index ad4570d..4b302a1 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -18,7 +18,7 @@ makedocs( "Index des fonctions" =>"fct_index.md", "Annexes" => "Annexes.md", #"Exemples d'appels" =>"Exemples.md", - "Mise en place" => "mise_en_place.md", + "Installation de Julia et tests unitaires" => "mise_en_place.md", #"Julia vs MatLab"=> "julia_vs_matlab.md", #"Création de Modules en Julia" => "create_package.md", #"Création d'un dépôt Git pour un module Julia" => "git_doc.md", diff --git a/docs/src/index.md b/docs/src/index.md index 441dea9..66f79d8 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,8 +6,13 @@ Le package [Optinum](https://github.com/mathn7/Optinum) concerne le projet d’O **Il ne faut en aucun cas modifier la structuration** de ce projet, ni les interfaces des fonctions. -Les fichiers `julia` que vous aurez à modifier se trouvent dans le répertoire `Optinum/src`. +Les fichiers `julia` que vous aurez à modifier se trouvent dans le répertoire `Optinum/src`. Ces fichier sont : +1. `TP-Projet-Optinum.ipynb`: c'est un julia notebook dans lequel vous ferez toutes vos expérimentations numériques et répondrez aux questions posées. Ce fichier est à ouvrir avec `jupyter notebook`. +2. Les fichiers `julia` qui codent les algorithmes demandés (voir le notebook). -Dans ce même répertoire se trouve notebook (`TP-Projet-Optinum.ipynb` que vous aurez aussi à modifier pour faire les expérimentations numériques et répondre aux questions posées. +Pour réaliser ce projet, vous avez besoin : +1. `julia`, version 1.4.1 ou plus récente; +2. des packages IJulia (pour avoir accès à `jupyter notebook pour julia) +3. des package LinearAlgebra, Markdown ###### Auteurs : O.Cots, J. Gergaud, S. Gratton, P. Matalon, C. Royer, D. Ruiz et E. Simon diff --git a/docs/src/mise_en_place.md b/docs/src/mise_en_place.md index 9fa5bd7..9b8c529 100644 --- a/docs/src/mise_en_place.md +++ b/docs/src/mise_en_place.md @@ -58,7 +58,7 @@ Besoin d'aide ? Consultez notre [F.A.Q.](FAQ.md) ## Lancement des tests -Dans le dossier `optinum/` faire : +Dans le dossier `Optinum/` faire : ```julia (@v1.) pkg> activate .