Skip to content

Commit 0b7a53c

Browse files
MaxBetzDLRMaxBetzDLR
MaxBetzDLR
authored and
MaxBetzDLR
committed
readme
1 parent bfe958c commit 0b7a53c

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

‎pycode/memilio-simulation/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ python setup.py install -- -DCMAKE_BUILD_TYPE=Debug -DMEMILIO_USE_BUNDLED_PYBIND
3838

3939
Alternatively, the `CMakeCache.txt` in the directory created by Scikit-Build can be edited to set the options.
4040

41+
## Stubs
42+
43+
A stub file is a file containing a skeleton of the public interface of that Python module including classes, variables, functions and their types. They help by enabling autocompletes and type annotations. `pybind11-stubgen` is used to automaticly generate the stub files for the MEmilio Python Bindings and provide them as a seperate stubs-only package.
44+
45+
For installation you need to have `memilio.simulation` and `pybind11-stubgen` installed for your python interpreter. Then run [generate_stubs.py](tools/generate_stubs.py) to generate the stubs-only package and install it as `memilio-stubs`, e.g.
46+
47+
```bash
48+
python ./tools/generate_stubs.py
49+
```
50+
4151
## Usage
4252

4353
The package provides the following modules:

pycode/memilio-simulation/generate_stubs.py renamed to pycode/memilio-simulation/tools/generate_stubs.py

File renamed without changes.

0 commit comments

Comments
 (0)