julia --project=. -e 'using Pkg; Pkg.add(["OrdinaryDiffEqLowStorageRK", "Plots"])' # Install additional packages</code></pre><p>If you use other packages for executing SimpleDiscontinuousGalerkin.jl, you can add them to the project in the <code>run</code> directory in an analogous way as above. To use the Julia project within <code>run</code>, be sure to start the Julia REPL by</p><pre><code class="language-sh hljs">julia --project=.</code></pre><p>if already inside the the <code>run</code> directory or <code>julia --project=run</code> if in the main directory of the repo.</p><h2 id="Preview-of-the-documentation"><a class="docs-heading-anchor" href="#Preview-of-the-documentation">Preview of the documentation</a><a id="Preview-of-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Preview-of-the-documentation" title="Permalink"></a></h2><p>If you want to build the documentation locally, you can run</p><pre><code class="language-sh hljs">julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'</code></pre><p>once from the SimpleDiscontinuousGalerkin.jl main directory to tell <a href="https://documenter.juliadocs.org/stable/man/guide/">Documenter.jl</a> to build the documentation of your local clone. To build the documentation, run</p><pre><code class="language-sh hljs">julia --project=docs --color=yes docs/make.jl</code></pre><p>The resulting <code>.html</code> files can then be found in <code>docs/build/</code> and you can look at them by opening them in a browser. For pull requests from the main repository (i.e. not from a fork), the documentation is automatically built and can be previewed under <code>https://JoshuaLampert.github.io/SimpleDiscontinuousGalerkin.jl/previews/PRXXX/</code> where <code>XXX</code> is the number of the pull request.</p><h2 id="Testing"><a class="docs-heading-anchor" href="#Testing">Testing</a><a id="Testing-1"></a><a class="docs-heading-anchor-permalink" href="#Testing" title="Permalink"></a></h2><p>In the test suite of SimpleDiscontinuousGalerkin.jl, the results of the examples are tested against reference solutions. This means that if you add an example and verified it works as expected, you should put the reference solution into the corresponding test. To obtain the reference solution and automatically copy it into the clipboard, you can run</p><pre><code class="language-julia hljs">errs = errors(analysis_callback)
0 commit comments