Merge branch 'master' of github.com:OPM/LBPM

This commit is contained in:
JamesEMcclure 2021-06-29 15:32:03 -04:00
commit 4b92170d21
2 changed files with 12 additions and 2 deletions

View File

@ -1,19 +1,27 @@
Dependencies for LBPM documentation
# install sphinx
```python
pip install Sphinx
```
# foamatting requires sphinx read-the-docs-theme
```python
pip install sphinx-rtd-theme
```
# equation rendering requires latex and dvipng command
```
sudo apt-get install dvipng
sudo apt-get install texlive texstudio
sudo apt-get install texlive-latex-recommended texlive-pictures texlive-latex-extra
```
# To build the docs
```
Step 1) install dependencies listed above
Step 2) type 'make html' from the docs/ directory
Step 3) point your browser at ~/local/doc/build/html/index.html
```
#

View File

@ -3,3 +3,5 @@ Visualizing simulation data with visit
======================================
placeholder for visit
Paraview > v 5.6 also works