Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JSchoeberl committed Mar 2, 2024
1 parent a33e025 commit 598305b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 4 deletions.
13 changes: 12 additions & 1 deletion _sources/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you like the material, show it by giving a star on github.

## Literature

* Lecture notes Schöberl and Faustmann+Schöberl
* Lecture notes Schöberl and Faustmann+Schöberl (available in TU-Wien TUWEL)

Books:

Expand Down Expand Up @@ -68,6 +68,17 @@ Known issues are
- If you get an error like `externally-managed-environment`, then either use
virtual environments, or add the flag `--break-system-packages` to the pip command, see [explanation](https://veronneau.org/python-311-pip-and-breaking-system-packages.html)

- If you have conflicts with other packages, you may install NGSolve in a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments). For example I did

python3 -m venv /Users/joachim/numpde
source /Users/joachim/numpde/bin/activate

- If NGSolve compuatations are working, but you don't get the rendering: For jupyter notebook version < 7.0.0 you have to run additionally

jupyter nbextension install --user --py webgui_jupyter_widgets
jupyter nbextension enable --user --py webgui_jupyter_widgets



If local installation does not work, there are alternatives:

Expand Down
16 changes: 14 additions & 2 deletions intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ <h1>An Interactive Introduction to the Finite Element Method<a class="headerlink
<section id="literature">
<h2>Literature<a class="headerlink" href="#literature" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Lecture notes Schöberl and Faustmann+Schöberl</p></li>
<li><p>Lecture notes Schöberl and Faustmann+Schöberl (available in TU-Wien TUWEL)</p></li>
</ul>
<p>Books:</p>
<ul class="simple">
Expand Down Expand Up @@ -517,10 +517,22 @@ <h2>Installing NGSolve<a class="headerlink" href="#installing-ngsolve" title="Li
</pre></div>
</div>
<p>Known issues are</p>
<ul class="simple">
<ul>
<li><p>Use pip3 instead of pip if there is no pip</p></li>
<li><p>If you get an error like <code class="docutils literal notranslate"><span class="pre">externally-managed-environment</span></code>, then either use
virtual environments, or add the flag <code class="docutils literal notranslate"><span class="pre">--break-system-packages</span></code> to the pip command, see <a class="reference external" href="https://veronneau.org/python-311-pip-and-breaking-system-packages.html">explanation</a></p></li>
<li><p>If you have conflicts with other packages, you may install NGSolve in a <a class="reference external" href="https://docs.python.org/3/library/venv.html#creating-virtual-environments">virtual environment</a>. For example I did</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m venv /Users/joachim/numpde
source /Users/joachim/numpde/bin/activate
</pre></div>
</div>
</li>
<li><p>If NGSolve compuatations are working, but you don’t get the rendering: For jupyter notebook version &lt; 7.0.0 you have to run additionally</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>jupyter nbextension install --user --py webgui_jupyter_widgets
jupyter nbextension enable --user --py webgui_jupyter_widgets
</pre></div>
</div>
</li>
</ul>
<p>If local installation does not work, there are alternatives:</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 598305b

Please sign in to comment.