Skip to content

Commit 78b3c3d

Browse files
improved readme
1 parent 2be1005 commit 78b3c3d

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ We provide the possibility of using Docker as a tool to provide a fully operatio
6767

6868
docker run -v `pwd`:/pwd_to_your_own_directory/ -i -t mathlab/deal2lkit:latest bash
6969

70-
to retrieve the environment. In such a shell you can easily compile the $\pi$-BEM library following its own instructions.
70+
to retrieve the environment. In such a shell you can easily compile the pi-BEM library following its own instructions.
7171

7272
## Install Procedure from scratch
7373
In order to successfully compile the code you need
@@ -79,7 +79,7 @@ In order to successfully compile the code you need
7979

8080

8181
### deal.II Installation procedure
82-
Follow the detailed [instruction](https://www.dealii.org/developer/readme.html) to install deal with METIS and Trilinos wrappers. We highlight that in order to fully exploit $\pi$-BEM you need to properly install the following additional packages: MPI, TBB, METIS, TRILINOS ans OPENCASCADE. For more detailed instruction you can look to the the deal.ii install procedures. In the following we provide an example of the installation of all the proper packages.
82+
Follow the detailed [instruction](https://www.dealii.org/developer/readme.html) to install deal with METIS and Trilinos wrappers. We highlight that in order to fully exploit pi-BEM you need to properly install the following additional packages: MPI, TBB, METIS, TRILINOS ans OPENCASCADE. For more detailed instruction you can look to the the deal.ii install procedures. In the following we provide an example of the installation of all the proper packages.
8383

8484

8585
### OpenCASCADE Installation procedure
@@ -124,7 +124,7 @@ Follow the detailed [instruction](https://www.dealii.org/developer/readme.html)
124124
Follow the detailed [instruction](https://https://github.com/mathLab/deal2lkit) to install deal2lkit.
125125

126126

127-
### $\pi$-BEM Installation procedure
127+
### pi-BEM Installation procedure
128128

129129
Then you can clone the repository and compile it
130130

@@ -159,7 +159,7 @@ this will automatically generate the parameter file for the bi-dimensional run w
159159

160160
will create a proper parameter file for a 3 dimensional simulation.
161161

162-
#Notice to developers
162+
# Notice to developers
163163

164164
Before making a pull request, please make sure you run the script
165165

@@ -171,7 +171,7 @@ white space changes are inserted in the repository.
171171
The script requires Artistic Style Version 2.04 (astyle) to work
172172
properly.
173173

174-
#Cite this work
174+
# Cite this work
175175

176176
If you use this software, please consider citing the following work:
177177

0 commit comments

Comments
 (0)