Skip to content

Update Python bindings section in README #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update Python bindings section in README #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a23eed0
Update Python bindings section in README
kennykos Sep 4, 2025
4273fca
Instr for adding PyGenten to python3 path after CMake install
kennykos Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,12 @@ to your configure options.

#### Python

GenTen provides Python bindings through a Python module called pygenten generated by [pybind11](https://github.com/pybind/pybind11). This can be enabled by adding the configuration option
GenTen provides Python bindings through a Python module called pygenten generated by [pybind11](https://github.com/pybind/pybind11) and requires shared libraries to be built by `CMake`. The bindings can be enabled by adding the configuration option
```
-D ENABLE_PYTHON=ON \
-D BUILD_SHARED_LIBS=ON \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this is actually only true on Linux. On Windows and Mac, you do not need to enable shared libraries.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kennykos can you clarify this is only needed on linux and not mac/windows?

```
which will compile GenTen to link against the version of python found in your environment. If the tests are going to be run, one must also have `pytest` installed. Furthermore, GenTen provides support for interoperability with pyttb. Several examples of using pygenten with and without pyttb can be found in [python/example](python/example).
which will compile GenTen to link against the version of python found in your environment. If the tests are going to be run, one must also have `pytest` installed. Furthermore, GenTen provides support for interoperability with pyttb. Several examples of using pygenten with and without pyttb can be found in [python/example](python/example). To `import pygenten` after a CMake build, add `/<PATH_TO_GENTEN_BUILD>/python` to your `$PYTHONPATH` environment variable.

Alternatively, pygenten can be directly installed using pip. See [python/README.md](python/README.md) for more details.

Expand Down
Loading