Skip to content

Commit

Permalink
build based on 9deb262
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 18, 2024
1 parent deea5c4 commit 312c49a
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-18T01:32:06","documenter_version":"1.4.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-18T01:34:46","documenter_version":"1.4.0"}}
2 changes: 1 addition & 1 deletion dev/generated/polynomial_inversion/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@
5 3.0381944444444586e-02 9 9
------------------------------------------------

</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sine/">« Sine function</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:32">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sine/">« Sine function</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:34">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/generated/sine/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@
</code></pre><p>Evaluate <code>y</code> at 1.0 and compare with the builtin <code>sin</code> function.</p><pre><code class="language-julia hljs">println(&quot; y(1.0) = $(DACE.evalScalar(y, 1.0))&quot;)
println(&quot;sin(1.0) = $(sin(1.0))&quot;)</code></pre><pre><code class="nohighlight hljs"> y(1.0) = 0.8414709848078965
sin(1.0) = 0.8414709848078965
</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/making-a-new-release-of-dace_jll/">« Making a new release of DACE_jll</a><a class="docs-footer-nextpage" href="../polynomial_inversion/">Polynomial inversion »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:32">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/making-a-new-release-of-dace_jll/">« Making a new release of DACE_jll</a><a class="docs-footer-nextpage" href="../polynomial_inversion/">Polynomial inversion »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:34">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/search_index.js
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/tutorials/making-a-new-release-of-dace_jll/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
git checkout -b update-dace

# switch to the D/DACE directory
cd D/DACE</code></pre></li><li><p>Edit the <em>build_tarballs.jl</em> file:</p><ul><li><p>bump the version of the release on or around line 11:</p><pre><code class="nohighlight hljs">version = v&quot;0.1.0&quot;</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>It is highly recommended to follow <a href="https://semver.org/">semantic versioning</a></p></div></div></li><li><p>change the commit hash (on or around line 15) that the new version will be based of to the hash of the commit you identified in step 2</p><pre><code class="nohighlight hljs">GitSource(&quot;https://github.com/a-ev/dace.git&quot;, &quot;9fe534f9b27c147a171bce1ad7dc8b4706a9457e&quot;),</code></pre><p>where <em>9fe534f9b27c147a171bce1ad7dc8b4706a9457e</em> is the commit hash</p></li></ul></li><li><p>Check the version of <em>libcxxwrap<em>julia</em>jll</em> which is linked to the version of <em>CxxWrap.jl</em>. When bumping the version of the CxxWrap dependency in the <em>DACE.jl</em> package you may also need to bump the version of <em>libcxxwrap<em>julia</em>jll</em> on or around line 55:</p><pre><code class="nohighlight hljs">Dependency(&quot;libcxxwrap_julia_jll&quot;; compat = &quot;~0.12.2&quot;),</code></pre><div class="admonition is-category-important"><header class="admonition-header">Important</header><div class="admonition-body"><p>Make sure the version of <em>libcxxwrap<em>julia</em>jll</em> is compatible with the version of <em>CxxWrap,jl</em> in your <em>Project.toml</em> for <em>DACE.jl</em></p></div></div></li><li><p>Commit and push your changes into your fork of Yggdrasil:</p><pre><code class="nohighlight hljs">git add build_tarballs.jl
cd D/DACE</code></pre></li><li><p>Edit the <em>build_tarballs.jl</em> file:</p><ul><li><p>bump the version of the release on or around line 11:</p><pre><code class="nohighlight hljs">version = v&quot;0.1.0&quot;</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>It is highly recommended to follow <a href="https://semver.org/">semantic versioning</a></p></div></div></li><li><p>change the commit hash (on or around line 15) that the new version will be based of to the hash of the commit you identified in step 2</p><pre><code class="nohighlight hljs">GitSource(&quot;https://github.com/a-ev/dace.git&quot;, &quot;9fe534f9b27c147a171bce1ad7dc8b4706a9457e&quot;),</code></pre><p>where <em>9fe534f9b27c147a171bce1ad7dc8b4706a9457e</em> is the commit hash</p></li></ul></li><li><p>Check the version of <em>libcxxwrap_julia_jll</em> which is linked to the version of <em>CxxWrap.jl</em>. When bumping the version of the CxxWrap dependency in the <em>DACE.jl</em> package you may also need to bump the version of <em>libcxxwrap_julia_jll</em> on or around line 55:</p><pre><code class="nohighlight hljs">Dependency(&quot;libcxxwrap_julia_jll&quot;; compat = &quot;~0.12.2&quot;),</code></pre><div class="admonition is-category-important"><header class="admonition-header">Important</header><div class="admonition-body"><p>Make sure the version of <em>libcxxwrap_julia_jll</em> is compatible with the version of <em>CxxWrap,jl</em> in your <em>Project.toml</em> for <em>DACE.jl</em></p></div></div></li><li><p>Commit and push your changes into your fork of Yggdrasil:</p><pre><code class="nohighlight hljs">git add build_tarballs.jl
git commit -m &quot;[DACE] bump version&quot;
git push</code></pre><p>You may need to set the upstream of your repo for <code>git push</code> to work. The above commands are just examples and may need tweaking.</p></li><li><p>Create a pull request back to the main Yggdrasil repo. The builds will run automatically and you can view their status in the pull request. If they all succeed someone will merge them automatically (you don&#39;t need to do anything else)</p></li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modifying-the-cxx-side-of-the-interface/">« Modifying the C++ side of the interface</a><a class="docs-footer-nextpage" href="../../generated/sine/">Sine function »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:32">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
git push</code></pre><p>You may need to set the upstream of your repo for <code>git push</code> to work. The above commands are just examples and may need tweaking.</p></li><li><p>Create a pull request back to the main Yggdrasil repo. The builds will run automatically and you can view their status in the pull request. If they all succeed someone will merge them automatically (you don&#39;t need to do anything else).</p></li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modifying-the-cxx-side-of-the-interface/">« Modifying the C++ side of the interface</a><a class="docs-footer-nextpage" href="../../generated/sine/">Sine function »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:34">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/tutorials/modifying-the-cxx-side-of-the-interface/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@
mod.method(&quot;+&quot;, [](const double c, const DA&amp; da) { return c + da; });

// until we call this, then subsequent calls to mod.method will add methods to our module again
mod.unset_override_module();</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../setting-up-your-development-environment/">« Setting up your development environment</a><a class="docs-footer-nextpage" href="../making-a-new-release-of-dace_jll/">Making a new release of DACE_jll »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:32">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
mod.unset_override_module();</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../setting-up-your-development-environment/">« Setting up your development environment</a><a class="docs-footer-nextpage" href="../making-a-new-release-of-dace_jll/">Making a new release of DACE_jll »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:34">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/tutorials/setting-up-your-development-environment/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@
std::cout &lt;&lt; &quot;initialising local version of DACE library...&quot; &lt;&lt; std::endl;
DA::init(ord, nvar);
});</code></pre><p>so that we can tell the local version has been loaded. Make the above change then save the file.</p><p>We should be in the <em>build</em> directory still. Execute the following command to build and install your change:</p><pre><code class="nohighlight hljs">VERBOSE=ON cmake --build . --config Release --target install -- -j${nproc}</code></pre><p>Now change back to the <em>DACE.jl</em> directory</p><pre><code class="nohighlight hljs">cd ../../DACE.jl</code></pre><p>Once again, enter the Julia REPL with <code>julia --project</code> and run the <code>DACE.init</code> function we ran above:</p><pre><code class="language-julia hljs">julia&gt; using DACE
julia&gt; DACE.init(10, 1)</code></pre><p>This time it should print out the string we just added (<em>initialising local version of DACE library...</em>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../modifying-the-cxx-side-of-the-interface/">Modifying the C++ side of the interface »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:32">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; DACE.init(10, 1)</code></pre><p>This time it should print out the string we just added (<em>initialising local version of DACE library...</em>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../modifying-the-cxx-side-of-the-interface/">Modifying the C++ side of the interface »</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.0 on <span class="colophon-date" title="Thursday 18 April 2024 01:34">Thursday 18 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 312c49a

Please sign in to comment.