Skip to content

Commit 572d8eb

Browse files
committed
Add pkg-config as a required dependency on the system, and minor formatting
1 parent 313441c commit 572d8eb

1 file changed

Lines changed: 21 additions & 22 deletions

File tree

README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@ Please refer to [the preCICE documentation](https://www.precice.org/installation
1212

1313
## Required dependencies
1414

15-
**preCICE**: Refer to [the preCICE documentation](https://precice.org/installation-overview.html) for information on building and installation.
16-
17-
**C++**: A working C++ compiler, e.g., `g++`.
18-
19-
**MPI**: `mpi4py` requires MPI to be installed on your system.
15+
- preCICE: Refer to [the preCICE documentation](https://precice.org/installation-overview.html) for information on building and installation.
16+
- A working C++ compiler, e.g., `g++`.
17+
- `mpi4py` requires MPI to be installed on your system.
18+
- pkg-config.
2019

2120
## Installing the package
2221

@@ -42,19 +41,19 @@ We recommend using `pip` (version 19.0.0 or newer required). You can check your
4241

4342
For system installs of preCICE, installation works out of the box. There are different ways how pip can be used to install pyprecice. pip will fetch cython and other build-time dependencies, compile the bindings and finally install the package pyprecice.
4443

45-
* (recommended) install [pyprecice from PyPI](https://pypi.org/project/pyprecice/)
44+
- (recommended) install [pyprecice from PyPI](https://pypi.org/project/pyprecice/)
4645

4746
```bash
4847
$ pip install pyprecice
4948
```
5049

51-
* provide the link to this repository to pip (replace `<branch>` with the branch you want to use, preferably `master` or `develop`)
50+
- provide the link to this repository to pip (replace `<branch>` with the branch you want to use, preferably `master` or `develop`)
5251

5352
```bash
5453
$ pip install https://github.com/precice/python-bindings.git@<branch>
5554
```
5655

57-
* if you already cloned this repository, execute the following command from this directory:
56+
- if you already cloned this repository, execute the following command from this directory:
5857

5958
```bash
6059
$ pip install .
@@ -66,8 +65,8 @@ For system installs of preCICE, installation works out of the box. There are dif
6665

6766
If preCICE (the C++ library) was installed in a custom prefix, or only built but not installed at all, you have to extend the following environment variables:
6867

69-
* `LIBRARY_PATH`, `LD_LIBRARY_PATH` to the library location, or `$prefix/lib`
70-
* `CPATH` either to the `src` directory or the `$prefix/include`
68+
- `LIBRARY_PATH`, `LD_LIBRARY_PATH` to the library location, or `$prefix/lib`
69+
- `CPATH` either to the `src` directory or the `$prefix/include`
7170

7271
The preCICE documentation provides more information on [linking preCICE](https://precice.org/installation-linking.html).
7372

@@ -109,13 +108,13 @@ $ python3 setup.py install
109108
```
110109

111110
**Options:**
112-
* `--include-dirs=`, default: `''`
111+
- `--include-dirs=`, default: `''`
113112
Path to the headers of preCICE, point to the sources `$PRECICE_ROOT/src`, or the your custom install prefix `$prefix/include`.
114113

115114
**NOTES:**
116115

117-
* If you have built preCICE using CMake, you can pass the path to the CMake binary directory using `--library-dirs`.
118-
* It is recommended to use preCICE as a shared library here.
116+
- If you have built preCICE using CMake, you can pass the path to the CMake binary directory using `--library-dirs`.
117+
- It is recommended to use preCICE as a shared library here.
119118

120119
4. Install the bindings
121120

@@ -264,8 +263,8 @@ boost 1.65.1 was installed per the `boost and yaml-cpp` guide above.
264263
In order to have the right python dependencies, a packaged conda environment was transferred to
265264
SuperMUC. The following dependencies were installed:
266265

267-
* numpy
268-
* mpi4py
266+
- numpy
267+
- mpi4py
269268

270269
With the python environment active, we have to feed the right python file directories to the cmake command.
271270
Note that -DPYTHON_LIBRARY expects a python shared library. You can likely modify the version to fit what is required.
@@ -335,10 +334,10 @@ Bindings versions up to `v3.0.0.0` have four digits, where the first three digit
335334

336335
## Contributors
337336

338-
* [Benjamin Rodenberg](https://github.com/BenjaminRodenberg)
339-
* [Ishaan Desai](https://github.com/IshaanDesai)
340-
* [Saumitra Vinay Joshi](https://github.com/saumiJ) contributed first working prototype in [`3db9c9` on `precice/precice`](https://github.com/precice/precice/commit/3db9c95e527db1e1cacb2fd116a5ce13ee877513)
341-
* [Frédéric Simonis](https://github.com/fsimonis)
342-
* [Florian Lindner](https://github.com/floli)
343-
* [Benjamin Uekermann](https://github.com/uekerman)
344-
* [Gerasimos Chourdakis](https://github.com/MakisH)
337+
- [Benjamin Rodenberg](https://github.com/BenjaminRodenberg)
338+
- [Ishaan Desai](https://github.com/IshaanDesai)
339+
- [Saumitra Vinay Joshi](https://github.com/saumiJ) contributed first working prototype in [`3db9c9` on `precice/precice`](https://github.com/precice/precice/commit/3db9c95e527db1e1cacb2fd116a5ce13ee877513)
340+
- [Frédéric Simonis](https://github.com/fsimonis)
341+
- [Florian Lindner](https://github.com/floli)
342+
- [Benjamin Uekermann](https://github.com/uekerman)
343+
- [Gerasimos Chourdakis](https://github.com/MakisH)

0 commit comments

Comments
 (0)