mirror of
https://github.com/OPM/opm-simulators.git
synced 2026-09-05 04:40:19 -05:00
Added sphinx documentation for Python bindings
Added sphinx documentation for the opm.simulators.BlackOilSimulator Python module. Added GitHub action workflow to deploy sphinx documentation to GitHub Pages.
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
# Python scripts for building opm-simulators sphinx documentation
|
||||
|
||||
## Installation of the python scripts
|
||||
- Requires python3 >= 3.10
|
||||
|
||||
### Using poetry
|
||||
For development it is recommended to use poetry:
|
||||
|
||||
- Install [poetry](https://python-poetry.org/docs/)
|
||||
- Then run:
|
||||
```
|
||||
$ poetry install
|
||||
$ poetry shell
|
||||
```
|
||||
|
||||
### Installation into virtual environment
|
||||
If you do not plan to change the code, you can do a regular installation into a VENV:
|
||||
|
||||
```
|
||||
$ python -m venv .venv
|
||||
$ source .venv/bin/activate
|
||||
$ pip install .
|
||||
```
|
||||
Reference in New Issue
Block a user