15 lines
9.2 KiB
HTML
15 lines
9.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>- · Optinum.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img src="assets/logo.png" alt="Optinum.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit">Optinum.jl</span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">Accueil</a></li><li><a class="tocitem" href="Sujet.html">Sujet</a></li><li><span class="tocitem">Algorithmes</span><ul><li><a class="tocitem" href="Algorithme_de_newton.html">L'algorithme de Newton local</a></li><li><a class="tocitem" href="Regions_de_confiance.html">La méthode des régions de confiance</a></li><li><a class="tocitem" href="Lagrangien_augmente.html">La méthode du Lagrangien augmenté</a></li></ul></li><li><a class="tocitem" href="fct_index.html">Index des fonctions</a></li><li><a class="tocitem" href="Annexes.html">Annexes</a></li><li><a class="tocitem" href="mise_en_place.html">Installation de Julia et tests unitaires</a></li><li><a class="tocitem" href="FAQ.html">Foire aux Questions</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="git_doc.html">-</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="git_doc.html">-</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com//blob/master/docs/src/git_doc.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h2 id="Créer-un-module-en-Julia-et-définir-ses-fonctions-1"><a class="docs-heading-anchor" href="#Créer-un-module-en-Julia-et-définir-ses-fonctions-1">Créer un module en Julia et définir ses fonctions</a><a class="docs-heading-anchor-permalink" href="#Créer-un-module-en-Julia-et-définir-ses-fonctions-1" title="Permalink"></a></h2><p>Pour générer un nouveau module, utilisez <code>pkg> generate Toto</code>, deux fichiers seront crées : <code>Project.toml</code> qui contient le nom du package, son UUID unique, sa version, l'auteur et les éventuelles dépendances et le fichier <code>src/Toto.jl</code> :</p><pre><code class="language-julia">module Toto
|
|
|
|
greet() = print("Hello World!")
|
|
include("Fonctions.jl")
|
|
|
|
end # module</code></pre><p>Dans ce fichier <code>Toto.jl</code>, on définit les fonctions du module. Dans l'exemple ci-dessus la fonction "greet()" et toutes les fonctions définies dans le fichier "Fonctions.jl" seront accessibles pour les utilisateurs du module.</p><h2 id="Définir-les-tests-du-module-:-1"><a class="docs-heading-anchor" href="#Définir-les-tests-du-module-:-1">Définir les tests du module :</a><a class="docs-heading-anchor-permalink" href="#Définir-les-tests-du-module-:-1" title="Permalink"></a></h2><p>Pour ajouter des tests à ce module :</p><ul><li>Créez un nouveau dossier <code>/test</code> (pas <code>/tests</code> !)</li><li>dedans créez un nouveau fichier <code>runtests.jl</code> (pas <code>runtest.jl</code> !)</li></ul><p>!! tous les tests devraient être inclus (avec des <code>include</code>) dans ce fichier. </p><h2 id="Créer-un-dépôt-Git-1"><a class="docs-heading-anchor" href="#Créer-un-dépôt-Git-1">Créer un dépôt Git</a><a class="docs-heading-anchor-permalink" href="#Créer-un-dépôt-Git-1" title="Permalink"></a></h2><p>Pour créer un dépôt sur Github:</p><ul><li>Rendez-vous sur <a href="github.com">github.com</a></li><li>Créez un compte si vous en avez pas</li><li><a href="https://github.com/new">Créez un dépôt</a>, il est recommandé de prendre le même nom que le Module (<code>Toto</code> dans notre cas).</li></ul><div class="admonition is-warning"><header class="admonition-header">Avertissement</header><div class="admonition-body"><ul><li>Ne cochez PAS <em>Initialize this repository with a README</em> !, mais si vous l'avez déja fait n'utilisez PAS la méthode suivante, mais plutôt la méthode <strong>Git clone</strong> ci-dessous.</li><li>Pour les authentifications, utilisez votre identifiant Github.</li></ul></div></div><ul><li>Ensuite,recupérez le lien de votre dépôt:</li></ul><p>| <a href="."><img src="https://sansnom.org/activities/discussions/documentation/free-software/pull-request/clone_https.png" alt/></a> |</p><ul><li>Lancez un terminal dans le dossier (<code>Toto</code> dans notre cas) contenant votre Module:</li></ul><pre><code class="language-none">git init
|
|
git add .
|
|
git commit -m "first commit"
|
|
git remote add origin https://le_lien_du_dépôt.git
|
|
git push -u origin master</code></pre><p>Dans la suite vous n'aurez plus besoin d'utiliser toute la commande <code>git push -u origin master</code>,mais juste <code>git push</code> pour pousser vos modifs.</p><h4 id="Git-clone-1"><a class="docs-heading-anchor" href="#Git-clone-1">Git clone</a><a class="docs-heading-anchor-permalink" href="#Git-clone-1" title="Permalink"></a></h4><ul><li>Pour ajouter vos fichier si vous avez initialisé votre dépôt lancez un terminal dans un dossier à coté du dossier contenant votre Module:</li></ul><pre><code class="language-none">git clone https://le_lien_du_dépôt.git </code></pre><ul><li>Un dossier au nom du dépôt sera crée, ajouter vos fichiers dedans,(<code>Project.toml</code>,<code>Manifest.toml</code>,<code>src/</code>,...)</li></ul><div class="admonition is-warning"><header class="admonition-header">Avertissement</header><div class="admonition-body"><p>Ajoutez les fichiers et pas le dossier contenant le module !</p></div></div><ul><li>Maintenant,allez dans le dossier du dépôt et dans un terminal :</li></ul><pre><code class="language-none">git add .
|
|
git commit -m "first commit"
|
|
git push</code></pre><p>Consultez <a href="https://guides.github.com/activities/hello-world/">cette page</a> pour savoir plus sur Git/Github.</p><h2 id="Utilisation-du-module-1"><a class="docs-heading-anchor" href="#Utilisation-du-module-1">Utilisation du module</a><a class="docs-heading-anchor-permalink" href="#Utilisation-du-module-1" title="Permalink"></a></h2><ul><li>Vous pouvez maintenant importé votre module:</li></ul><pre><code class="language-julia">julia> ]
|
|
pkg> add https://le_lien_du_dépôt.git</code></pre><ul><li>pour le tester: </li></ul><pre><code class="language-julia">pkg> test Toto</code></pre><ul><li>pour l'utiliser:</li></ul><pre><code class="language-julia">julia> using Toto</code></pre></article></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Monday 8 November 2021 11:31">Monday 8 November 2021</span>. Using Julia version 1.4.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|