Skip to content

Commit

Permalink
remove xeus-cling comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mwiesenberger committed Sep 25, 2023
1 parent 9f11421 commit 68a2900
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 17 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,12 @@ In order to generate the static website we use
[jupyter-book](https://jupyterbook.org).

```bash
# install xeus-cling for the C++ kernel
conda create -n cling # we need a new environment
source activate cling
conda install xeus-cling -c conda-forge
conda install notebook # the global jupyter-notebook does not see the new C++ kernel
# install jupyter-book
conda install jupyter-book -c conda-forge
# clone this repository
git clone https://github.com/feltor-dev/user-guide
# build the book
jupyter-book build path/to/user-guide
# we use ghp-import to publish changes on the github pages
pip install ghp-import
```
In order to locally generate the simulation data you will need the
[Feltor](https://github.com/feltor-dev/feltor) code repository. Follow the
Expand All @@ -40,6 +33,15 @@ pip install ghp-import
cd path/to/user-guide
ghp-import -n -f -p -o _build/html
```

## Last succesful build
```bash
Jupyter Book : 0.12.1
External ToC : 0.2.3
MyST-Parser : 0.15.2
MyST-NB : 0.13.1
Sphinx Book Theme : 0.1.10
Jupyter-Cache : 0.4.3
NbClient : 0.5.3
```
## Author
Matthias Wiesenberger
2 changes: 1 addition & 1 deletion grids.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(sec:grids)=
# Grids and derivatives

In the first two chapters we saw how to deal with vectors and how to integrate
our first ordinary differential equation. But how about partial
differential equations? In order to define a partial differential
Expand Down
8 changes: 4 additions & 4 deletions json-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ try{
{
std::cout << e.what();
}
// An error occured while parsing does_not_exist.json
// *** File does not exist! ***
```

An error occured while parsing does_not_exist.json
*** File does not exist! ***

In this example we open a file where C-style comments are allowed but discarded, while an error on opening or reading the file leads to a throw (which if not captured leads to immediate abortion of the program).

Expand Down Expand Up @@ -65,10 +65,10 @@ try{
std::cout << "Error in file test.json\n";
std::cout << e.what()<<std::endl;
}
// Error in file test.json
// *** Key error: "does not exist": not found.
```

Error in file test.json
*** Key error: "does not exist": not found.

A feature of the class is that it keeps track of how a value is called.
For example
Expand Down
3 changes: 2 additions & 1 deletion timesteppers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Timesteppers
(sec:timesteppers)=
# ODE integrators
This chapter deals with how to integrate differential equations of the form
\begin{align}
M(y,t) \frac{d}{dt}y = F(y,t)
Expand Down
6 changes: 3 additions & 3 deletions welcome.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(sec:welcome)=
# Welcome
This guide explains how to use Feltor.
It's structure follows the basic structure of Feltor itself as described
Expand All @@ -10,9 +11,8 @@ If you haven't done so yet, please read the
explains how to install the library and compile programs.

```{note}
This guide is generated using [jupyter-book](https://jupyterbook.org/intro.html) from [jupyter-notebooks](https://jupyter.org/) with the [xeus-cling](https://github.com/jupyter-xeus/xeus-cling) extension, which allows to run C++ code in a jupyter-notebook. This means that you can download and execute the notebooks yourself and we encourage you to do so and play around with the provided examples. Or, you can simply copy-paste the code examples into a textfile and compile the code yourself.
Unfortunately, xeus-cling does not generate terribly fast code and only works unparallelized so compiling yourself probably yields faster executables.
This guide is generated using [jupyter-book](https://jupyterbook.org/intro.html) from [jupyter-notebooks](https://jupyter.org/) and Markdown files.
You can simply copy-paste the code examples into a textfile and compile the code yourself and we encourage you to do so and play around with the provided examples.
```

```{seealso}
Expand Down

0 comments on commit 68a2900

Please sign in to comment.