Skip to content

Commit

Permalink
build based on 1a8567e
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 17, 2024
1 parent b41c029 commit 01b3025
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion previews/PR338/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-05-17T20:23:21","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-05-17T21:03:35","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion previews/PR338/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@
author={Shin, Sungho and Coffrin, Carleton and Sundar, Kaarthik and Zavala, Victor M},
journal={arXiv preprint arXiv:2010.02404},
year={2020}
}</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="installation/">Installation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></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="auto">Automatic (OS)</option><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> version 1.4.1 on <span class="colophon-date" title="Friday 17 May 2024 20:23">Friday 17 May 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="installation/">Installation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></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="auto">Automatic (OS)</option><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> version 1.4.1 on <span class="colophon-date" title="Friday 17 May 2024 21:03">Friday 17 May 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR338/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Installation · MadNLP.jl</title><meta name="title" content="Installation · MadNLP.jl"/><meta property="og:title" content="Installation · MadNLP.jl"/><meta property="twitter:title" content="Installation · MadNLP.jl"/><meta name="description" content="Documentation for MadNLP.jl."/><meta property="og:description" content="Documentation for MadNLP.jl."/><meta property="twitter:description" content="Documentation for MadNLP.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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" data-theme-primary-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><link href="../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="MadNLP.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">MadNLP.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Installation</a><ul class="internal"><li><a class="tocitem" href="#HSL-linear-solver"><span>HSL linear solver</span></a></li><li><a class="tocitem" href="#Mumps-linear-solver"><span>Mumps linear solver</span></a></li><li><a class="tocitem" href="#Pardiso-linear-solver"><span>Pardiso linear solver</span></a></li></ul></li><li><a class="tocitem" href="../quickstart/">Quickstart</a></li><li><a class="tocitem" href="../options/">Options</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../man/solver/">IPM solver</a></li><li><a class="tocitem" href="../man/kkt/">KKT systems</a></li><li><a class="tocitem" href="../man/linear_solvers/">Linear Solvers</a></li></ul></li><li><span class="tocitem">API Reference</span><ul><li><a class="tocitem" href="../lib/ipm/">IPM solver</a></li><li><a class="tocitem" href="../lib/callbacks/">Callback wrappers</a></li><li><a class="tocitem" href="../lib/kkt/">KKT systems</a></li><li><a class="tocitem" href="../lib/linear_solvers/">Linear Solvers</a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Installation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Installation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/MadNLP/MadNLP.jl/blob/master/docs/src/installation.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h1><p>To install MadNLP, simply proceed to</p><pre><code class="language-julia hljs">pkg&gt; add MadNLP
</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The default installation comes is shipped only with two linear solvers (Umfpack and Lapack), which are not adapted to solve the KKT systems arising in large-scale nonlinear problems. We recommend using a specialized linear solver to speed-up the solution of the KKT systems.</p></div></div><p>In addition to Lapack and Umfpack, the user can install the following extensions to use a specialized linear solver.</p><h2 id="HSL-linear-solver"><a class="docs-heading-anchor" href="#HSL-linear-solver">HSL linear solver</a><a id="HSL-linear-solver-1"></a><a class="docs-heading-anchor-permalink" href="#HSL-linear-solver" title="Permalink"></a></h2><p>Obtain a license and download HSL_jll.jl from https://licences.stfc.ac.uk/product/julia-hsl. There are two versions available: LBT and OpenBLAS. LBT is the recommended option for Julia &gt;= v1.9. Install this download into your current environment using:</p><pre><code class="language-julia hljs">import Pkg
Pkg.develop(path = &quot;/full/path/to/HSL_jll.jl&quot;)</code></pre><p>If the user has already compiled the HSL solver library, one can simply override the path to the artifact by editing <code>~/.julia/artifacts/Overrides.toml</code></p><pre><code class="nohighlight hljs"># replace HSL_jll artifact /usr/local/lib/libhsl.so
ecece3e2c69a413a0e935cf52e03a3ad5492e137 = &quot;/usr/local&quot;</code></pre><h2 id="Mumps-linear-solver"><a class="docs-heading-anchor" href="#Mumps-linear-solver">Mumps linear solver</a><a id="Mumps-linear-solver-1"></a><a class="docs-heading-anchor-permalink" href="#Mumps-linear-solver" title="Permalink"></a></h2><p>Mumps is an open-source sparse linear solver, whose binaries are kindly provided as a Julia artifact. Installing Mumps simply amounts to</p><pre><code class="language-julia hljs">pkg&gt; add MadNLPMumps</code></pre><h2 id="Pardiso-linear-solver"><a class="docs-heading-anchor" href="#Pardiso-linear-solver">Pardiso linear solver</a><a id="Pardiso-linear-solver-1"></a><a class="docs-heading-anchor-permalink" href="#Pardiso-linear-solver" title="Permalink"></a></h2><p>To use Pardiso, the user needs to obtain the Pardiso shared libraries from <a href="https://panua.ch/">https://panua.ch/</a>, provide the absolute path to the shared library:</p><pre><code class="nohighlight hljs">julia&gt; ENV[&quot;MADNLP_PARDISO_LIBRARY_PATH&quot;] = &quot;/usr/lib/libpardiso600-GNU800-X86-64.so&quot;</code></pre><p>and place the license file in the home directory. After obtaining the library and the license file, run</p><pre><code class="language-julia hljs">pkg&gt; build MadNLPPardiso</code></pre><p>The build process requires a C compiler.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../quickstart/">Quickstart »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></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="auto">Automatic (OS)</option><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> version 1.4.1 on <span class="colophon-date" title="Friday 17 May 2024 20:23">Friday 17 May 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
ecece3e2c69a413a0e935cf52e03a3ad5492e137 = &quot;/usr/local&quot;</code></pre><h2 id="Mumps-linear-solver"><a class="docs-heading-anchor" href="#Mumps-linear-solver">Mumps linear solver</a><a id="Mumps-linear-solver-1"></a><a class="docs-heading-anchor-permalink" href="#Mumps-linear-solver" title="Permalink"></a></h2><p>Mumps is an open-source sparse linear solver, whose binaries are kindly provided as a Julia artifact. Installing Mumps simply amounts to</p><pre><code class="language-julia hljs">pkg&gt; add MadNLPMumps</code></pre><h2 id="Pardiso-linear-solver"><a class="docs-heading-anchor" href="#Pardiso-linear-solver">Pardiso linear solver</a><a id="Pardiso-linear-solver-1"></a><a class="docs-heading-anchor-permalink" href="#Pardiso-linear-solver" title="Permalink"></a></h2><p>To use Pardiso, the user needs to obtain the Pardiso shared libraries from <a href="https://panua.ch/">https://panua.ch/</a>, provide the absolute path to the shared library:</p><pre><code class="nohighlight hljs">julia&gt; ENV[&quot;MADNLP_PARDISO_LIBRARY_PATH&quot;] = &quot;/usr/lib/libpardiso600-GNU800-X86-64.so&quot;</code></pre><p>and place the license file in the home directory. After obtaining the library and the license file, run</p><pre><code class="language-julia hljs">pkg&gt; build MadNLPPardiso</code></pre><p>The build process requires a C compiler.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../quickstart/">Quickstart »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></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="auto">Automatic (OS)</option><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> version 1.4.1 on <span class="colophon-date" title="Friday 17 May 2024 21:03">Friday 17 May 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 01b3025

Please sign in to comment.