Skip to content

Commit

Permalink
Add entry in README.md for autocompletion in VS Code
Browse files Browse the repository at this point in the history
  • Loading branch information
lisajulia committed Apr 26, 2024
1 parent 2063844 commit d99e29b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@ This folder contains the Python bindings and code required for embedding python

For the Python bindings, see the [Python bindings of opm-simulators](https://github.com/OPM/opm-simulators/blob/master/python/README.md).

For embedding python, see the [documentation](https://opm-project.org/?page_id=1454).
For embedding python, see the [documentation](https://opm-project.org/?page_id=1454).

To enable tooltips for opm_embedded on VSCode (embedded python code):
- Create a stub file from the shared library opmcommon_python located in <opm-common-build-folder>/python/opm using "stubgen -m opmcommon_python"
- This will crate a opmcommon_python.pyi file
- Rename the file to "opm_embedded.pyi" and place that file in the folder at "python.analysis.stubPath" of VS Code

0 comments on commit d99e29b

Please sign in to comment.