OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity
fa3392fb7d
opm-simulators/python/sphinx_docs/README.md
Håkon Hægland 566a844fef 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.
2024-05-14 09:00:52 +02:00

509 B
Raw Blame History

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:

$ 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 .