-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jan 23, 2024
1 parent
aec9596
commit c983b1f
Showing
2 changed files
with
2 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-01-23T20:32:02","documenter_version":"1.2.1"}} | ||
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-01-23T20:43:09","documenter_version":"1.2.1"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>DACE.jl · DACE.jl</title><meta name="title" content="DACE.jl · DACE.jl"/><meta property="og:title" content="DACE.jl · DACE.jl"/><meta property="twitter:title" content="DACE.jl · DACE.jl"/><meta name="description" content="Documentation for DACE.jl."/><meta property="og:description" content="Documentation for DACE.jl."/><meta property="twitter:description" content="Documentation for DACE.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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>DACE.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 class="is-active"><a class="tocitem" href>DACE.jl</a><ul class="internal"><li><a class="tocitem" href="#Getting-started"><span>Getting started</span></a></li><li><a class="tocitem" href="#Notes-about-the-interface"><span>Notes about the interface</span></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>DACE.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>DACE.jl</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/chrisdjscott/DACE.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/chrisdjscott/DACE.jl/blob/main/docs/src/index.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="DACE.jl"><a class="docs-heading-anchor" href="#DACE.jl">DACE.jl</a><a id="DACE.jl-1"></a><a class="docs-heading-anchor-permalink" href="#DACE.jl" title="Permalink"></a></h1><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This package is still in development, is not complete and instructions may change significantly</p></div></div><p>This is the documentation page for <a href="https://github.com/chrisdjscott/DACE.jl">DACE.jl</a>, a Julia interface to the <a href="https://github.com/dacelib/dace">DACE library</a>.</p><h2 id="Getting-started"><a class="docs-heading-anchor" href="#Getting-started">Getting started</a><a id="Getting-started-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-started" title="Permalink"></a></h2><p>DACE.jl can be installed using the Julia package manager. From the Julia REPL, type <code>]</code> to enter the Pkg REPL mode and run</p><pre><code class="nohighlight hljs">pkg> add https://github.com/chrisdjscott/DACE_jll.jl.git | ||
pkg> add https://github.com/chrisdjscott/DACE.jl.git</code></pre><h2 id="Notes-about-the-interface"><a class="docs-heading-anchor" href="#Notes-about-the-interface">Notes about the interface</a><a id="Notes-about-the-interface-1"></a><a class="docs-heading-anchor-permalink" href="#Notes-about-the-interface" title="Permalink"></a></h2><ul><li>The Julia interface is built using <a href="https://github.com/JuliaInterop/CxxWrap.jl">CxxWrap.jl</a></li><li>The C++ source for the interface is currently in <a href="https://github.com/chrisdjscott/dace/tree/julia-interface/interfaces/julia">this fork</a> of the DACE library</li><li>The C++ code gets built and released to the DACE_jll package, currently located <a href="https://github.com/chrisdjscott/DACE_jll.jl">here</a></li><li>The Julia component of the interface is currently <a href="https://github.com/chrisdjscott/DACE.jl">here</a></li></ul><p>The above may change, in particular we hope to:</p><ul><li>merge the forked DACE library back to <a href="https://github.com/dacelib/dace">upstream</a>, if possible</li><li>release the DACE_jll package with <a href="https://github.com/JuliaPackaging/Yggdrasil">Yggdrasil</a></li><li>move the DACE.jl package under the <a href="https://github.com/dacelib">dacelib</a> organisation on GitHub, if possible</li></ul></article><nav class="docs-footer"><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 23 January 2024 20:32">Tuesday 23 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
pkg> add https://github.com/chrisdjscott/DACE.jl.git</code></pre><h2 id="Notes-about-the-interface"><a class="docs-heading-anchor" href="#Notes-about-the-interface">Notes about the interface</a><a id="Notes-about-the-interface-1"></a><a class="docs-heading-anchor-permalink" href="#Notes-about-the-interface" title="Permalink"></a></h2><ul><li>The Julia interface is built using <a href="https://github.com/JuliaInterop/CxxWrap.jl">CxxWrap.jl</a></li><li>The C++ source for the interface is currently in <a href="https://github.com/chrisdjscott/dace/tree/julia-interface/interfaces/julia">this fork</a> of the DACE library</li><li>The C++ code gets built and released to the DACE_jll package, currently located <a href="https://github.com/chrisdjscott/DACE_jll.jl">here</a></li><li>The Julia component of the interface is currently <a href="https://github.com/chrisdjscott/DACE.jl">here</a></li></ul><p>The above may change, in particular we hope to:</p><ul><li>merge the forked DACE library back to <a href="https://github.com/dacelib/dace">upstream</a>, if possible</li><li>release the DACE_jll package with <a href="https://github.com/JuliaPackaging/Yggdrasil">Yggdrasil</a></li><li>move the DACE.jl package under the <a href="https://github.com/dacelib">dacelib</a> organisation on GitHub, if possible</li></ul></article><nav class="docs-footer"><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 23 January 2024 20:43">Tuesday 23 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |