Skip to content

Commit adfbe28

Browse files
author
Documenter.jl
committed
build based on 179d0ac
1 parent a641d90 commit adfbe28

8 files changed

Lines changed: 314 additions & 314 deletions

File tree

julia-docs/dev/docstrings.html

Lines changed: 135 additions & 135 deletions
Large diffs are not rendered by default.

julia-docs/dev/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h2 class="anchored" data-anchor-id="usage">Usage</h2>
233233
<p>First install and run Julia https://julialang.org/downloads/</p>
234234
<p>Next download or clone this repository.</p>
235235
<p>Finally, to use MEDYAN.jl, in Julia run:</p>
236-
<div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Pkg;</span> pkg"dev &lt;path to repo&gt;"</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
236+
<div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Pkg;</span> pkg"dev &lt;path to repo&gt;/MEDYAN"</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
237237
<p>Where <code>&lt;path to repo&gt;</code> should be replaced with a local or absolute path to the repo.</p>
238238
<ul>
239239
<li><a href="https://medyan.org/julia-docs/dev/tutorials/1install.html">Tutorials</a></li>
@@ -272,20 +272,20 @@ <h2 class="anchored" data-anchor-id="authors">Authors</h2>
272272
<section id="running-tests" class="level2">
273273
<h2 class="anchored" data-anchor-id="running-tests">Running tests</h2>
274274
<p>In shell:</p>
275-
<div class="sourceCode" id="cb2"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> test</span>
275+
<div class="sourceCode" id="cb2"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> MEDYAN/test</span>
276276
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="ex">julia</span> <span class="at">--project</span> <span class="at">-e</span> <span class="st">'using Pkg; Pkg.instantiate()'</span></span>
277277
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="ex">julia</span> <span class="at">--project</span> runtests.jl</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
278278
<p>You can also include individual test files to run just those tests.</p>
279279
</section>
280280
<section id="sub-packages" class="level2">
281281
<h2 class="anchored" data-anchor-id="sub-packages">Sub Packages</h2>
282-
<p>There are a number of sub packages found in the “lib” directory.</p>
283-
<p>For example “lib/MEDYAN2Vtk”, can be tested using the following shell commands:</p>
284-
<div class="sourceCode" id="cb3"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> lib/MEDYAN2Vtk/test</span>
282+
<p>There are a number of sub packages found in the root directory.</p>
283+
<p>For example “MEDYAN2Vtk”, can be tested using the following shell commands:</p>
284+
<div class="sourceCode" id="cb3"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> MEDYAN2Vtk/test</span>
285285
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="ex">julia</span> <span class="at">--project</span> <span class="at">-e</span> <span class="st">'using Pkg; Pkg.instantiate()'</span></span>
286286
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="ex">julia</span> <span class="at">--project</span> runtests.jl</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
287-
<p>To use “lib/MEDYAN2Vtk” package in a new environment in Julia run:</p>
288-
<div class="sourceCode" id="cb4"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Pkg;</span> pkg"dev &lt;path to repo&gt;/lib/MEDYAN2Vtk"</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
287+
<p>To use “MEDYAN2Vtk” package in a new environment in Julia run:</p>
288+
<div class="sourceCode" id="cb4"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Pkg;</span> pkg"dev &lt;path to repo&gt;/MEDYAN2Vtk"</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
289289
<p>If the sub package depends on other sub packages or depends on MEDYAN, you may have to dev multiple paths.</p>
290290
</section>
291291
<section id="running-notebooks" class="level2">

julia-docs/dev/medyan-tutorial.zip

1.69 KB
Binary file not shown.

julia-docs/dev/search.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1303,7 +1303,7 @@
13031303
"href": "index.html#usage",
13041304
"title": "MEDYAN.jl",
13051305
"section": "Usage",
1306-
"text": "Usage\nFirst install and run Julia https://julialang.org/downloads/\nNext download or clone this repository.\nFinally, to use MEDYAN.jl, in Julia run:\nusing Pkg; pkg\"dev &lt;path to repo&gt;\"\nWhere &lt;path to repo&gt; should be replaced with a local or absolute path to the repo.\n\nTutorials\nReference"
1306+
"text": "Usage\nFirst install and run Julia https://julialang.org/downloads/\nNext download or clone this repository.\nFinally, to use MEDYAN.jl, in Julia run:\nusing Pkg; pkg\"dev &lt;path to repo&gt;/MEDYAN\"\nWhere &lt;path to repo&gt; should be replaced with a local or absolute path to the repo.\n\nTutorials\nReference"
13071307
},
13081308
{
13091309
"objectID": "index.html#authors",
@@ -1317,14 +1317,14 @@
13171317
"href": "index.html#running-tests",
13181318
"title": "MEDYAN.jl",
13191319
"section": "Running tests",
1320-
"text": "Running tests\nIn shell:\ncd test\njulia --project -e 'using Pkg; Pkg.instantiate()'\njulia --project runtests.jl\nYou can also include individual test files to run just those tests."
1320+
"text": "Running tests\nIn shell:\ncd MEDYAN/test\njulia --project -e 'using Pkg; Pkg.instantiate()'\njulia --project runtests.jl\nYou can also include individual test files to run just those tests."
13211321
},
13221322
{
13231323
"objectID": "index.html#sub-packages",
13241324
"href": "index.html#sub-packages",
13251325
"title": "MEDYAN.jl",
13261326
"section": "Sub Packages",
1327-
"text": "Sub Packages\nThere are a number of sub packages found in the “lib” directory.\nFor example “lib/MEDYAN2Vtk”, can be tested using the following shell commands:\ncd lib/MEDYAN2Vtk/test\njulia --project -e 'using Pkg; Pkg.instantiate()'\njulia --project runtests.jl\nTo use “lib/MEDYAN2Vtk” package in a new environment in Julia run:\nusing Pkg; pkg\"dev &lt;path to repo&gt;/lib/MEDYAN2Vtk\"\nIf the sub package depends on other sub packages or depends on MEDYAN, you may have to dev multiple paths."
1327+
"text": "Sub Packages\nThere are a number of sub packages found in the root directory.\nFor example “MEDYAN2Vtk”, can be tested using the following shell commands:\ncd MEDYAN2Vtk/test\njulia --project -e 'using Pkg; Pkg.instantiate()'\njulia --project runtests.jl\nTo use “MEDYAN2Vtk” package in a new environment in Julia run:\nusing Pkg; pkg\"dev &lt;path to repo&gt;/MEDYAN2Vtk\"\nIf the sub package depends on other sub packages or depends on MEDYAN, you may have to dev multiple paths."
13281328
},
13291329
{
13301330
"objectID": "index.html#running-notebooks",
@@ -1444,7 +1444,7 @@
14441444
"href": "tutorials/1install.html",
14451445
"title": "1. Installing MEDYAN.jl",
14461446
"section": "",
1447-
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.11.5\nCommit 760b2e5b739 (2025-04-14 06:53 UTC)\nBuild Info:\n Official https://julialang.org/ release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-16.0.6 (ORCJIT, skylake)\nThreads: 1 default, 0 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner6/_work/_tool/julia/1.11.5/x64/bin/../lib/julia:/home/gh-actions1/actions-runner6/_work/_tool/julia/1.11.5/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.\n\n\n\nDownload the exact julia environment used to generate the tutorials.\nClick to Download\nNext extract this zip file and cd into the extracted directory.\nNow run\njulia --project -e 'import Pkg; Pkg.instantiate()'\nTo start the julia REPL in the correct environment to run the tutorials, use:\njulia --project\nFrom inside the medyan-tutorial directory.\nYou can also save julia files in this directory and use the VSCode julia extension to set the environment, and run code blocks, if you prefer that over the REPL.\nhttps://code.visualstudio.com/docs/languages/julia\n\n\n\nThese tests may take a few minutes to run.\njulia lib/MEDYAN/test/install-deps.jl\njulia --project=lib/MEDYAN/test lib/MEDYAN/test/runtests.jl\nIf you have any errors or failing tests create an issue",
1447+
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.11.5\nCommit 760b2e5b739 (2025-04-14 06:53 UTC)\nBuild Info:\n Official https://julialang.org/ release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-16.0.6 (ORCJIT, skylake)\nThreads: 1 default, 0 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner4/_work/_tool/julia/1.11.5/x64/bin/../lib/julia:/home/gh-actions1/actions-runner4/_work/_tool/julia/1.11.5/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.\n\n\n\nDownload the exact julia environment used to generate the tutorials.\nClick to Download\nNext extract this zip file and cd into the extracted directory.\nNow run\njulia --project -e 'import Pkg; Pkg.instantiate()'\nTo start the julia REPL in the correct environment to run the tutorials, use:\njulia --project\nFrom inside the medyan-tutorial directory.\nYou can also save julia files in this directory and use the VSCode julia extension to set the environment, and run code blocks, if you prefer that over the REPL.\nhttps://code.visualstudio.com/docs/languages/julia\n\n\n\nThese tests may take a few minutes to run.\njulia lib/MEDYAN/test/install-deps.jl\njulia --project=lib/MEDYAN/test lib/MEDYAN/test/runtests.jl\nIf you have any errors or failing tests create an issue",
14481448
"crumbs": [
14491449
"Tutorials",
14501450
"1. Installing MEDYAN.jl"
@@ -1455,7 +1455,7 @@
14551455
"href": "tutorials/1install.html#install-julia",
14561456
"title": "1. Installing MEDYAN.jl",
14571457
"section": "",
1458-
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.11.5\nCommit 760b2e5b739 (2025-04-14 06:53 UTC)\nBuild Info:\n Official https://julialang.org/ release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-16.0.6 (ORCJIT, skylake)\nThreads: 1 default, 0 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner6/_work/_tool/julia/1.11.5/x64/bin/../lib/julia:/home/gh-actions1/actions-runner6/_work/_tool/julia/1.11.5/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.",
1458+
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.11.5\nCommit 760b2e5b739 (2025-04-14 06:53 UTC)\nBuild Info:\n Official https://julialang.org/ release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-16.0.6 (ORCJIT, skylake)\nThreads: 1 default, 0 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner4/_work/_tool/julia/1.11.5/x64/bin/../lib/julia:/home/gh-actions1/actions-runner4/_work/_tool/julia/1.11.5/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.",
14591459
"crumbs": [
14601460
"Tutorials",
14611461
"1. Installing MEDYAN.jl"

0 commit comments

Comments
 (0)