Skip to content

Commit 4bf6c18

Browse files
committed
Update the README
1 parent 139140e commit 4bf6c18

File tree

1 file changed

+2
-31
lines changed

1 file changed

+2
-31
lines changed

README.md

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@ through python this enables many applications beyond simple simulations
2020
diagnostics. The only downside is of course that all functions are
2121
unparallelized in python.
2222

23-
As a second addition, now also Feltor's geometries extension is available in python.
23+
As a second addition, Feltor's geometries extension is available in python.
2424
However, the geometries functions and classes are not re-implemented in python, but
2525
they are bound to python via the [pybind11](https://github.com/pybind/pybind11)
2626
library. As such the corresponding C++ binding code must be compiled in order
2727
to generate the module `dg.geo`.
2828
## Installation
29-
### The pyfeltor.dg module
30-
> You need python3 to install this module
29+
> The `pyfeltor.dg.geo` part of the module contains python bindings for the underlying C++ [feltor](https://github.com/feltor-dev/feltor) code using [pybind11](https://github.com/pybind/pybind11). During installation the C++ code will be compiled using cmake, which may take a minute or two.
3130
3231
The simplest way is to install from the python package index [pypi](https://pypi.org/) via the package manager [pip](https://pip.pypa.io/en/stable/) v23.0
3332
```bash
@@ -45,34 +44,6 @@ cd tests
4544
pytest-3 -s . # run all the unittests with output
4645
```
4746

48-
### The pyfeltor.dg.geo module
49-
Currently, the only way to install this module is via a local, editable install.
50-
Assuming that the pyfeltor.dg module was succesfully installed this way
51-
- the first step is to also install [feltor](https://github.com/feltor-dev/feltor)
52-
following the quick start guide for a base installation.
53-
- Second, instead of jsoncpp we here use the
54-
[nlohmann/json](https://github.com/nlohmann/json) parser available either as a
55-
system package `nlohmann-json3-dev`.
56-
- Next, we follow the first steps guide on [pybind11](https://github.com/pybind11/pybind11)
57-
and install it via `python3 -m pip install pybind11`.
58-
- Further, we install the 'python3-dev', `pybind11-dev` and `pybind11-json-dev` system packages for
59-
the corresponding C++ header files.
60-
61-
Finally, invoke the Makefile in this repository
62-
```bash
63-
export FELTOR_PATH=path/to/feltor
64-
make -j 4
65-
```
66-
Replace `path/to/feltor` with the path to the Feltor library relative to the current
67-
directory. By default `FELTOR_PATH=../feltor`.
68-
69-
That's it. With the editable install the `pyfeltor.dg.geo` module is now automatically
70-
imported together with `pyfeltor.dg`.
71-
You can test if it works by executing the test
72-
```bash
73-
cd tests
74-
pytest -s test_geometries
75-
```
7647
## Usage
7748

7849
Generally, pyfeltor is built to mimic the `dg` library in feltor.

0 commit comments

Comments
 (0)