Skip to content

Commit

Permalink
Notebook instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
gaetanserre committed Jul 14, 2024
1 parent e865848 commit 8aaa28c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ jobs:
needs: build-x86-linux
steps:
- uses: actions/checkout@v4

- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master

- name: Install dependencies
run: |
Expand All @@ -68,7 +64,11 @@ jobs:
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/')
with:
body: "Please, make sure to put `pygkls*.so` in the Python package directory and `libpygkls.{so, dylib}` in the dinamyc library directory."
body: "
Please, make sure to put `pygkls*.so` in the Python package directory and `libpygkls.{so, dylib}` in the dinamyc library directory.
> [!WARNING]
> To use pyGKLS in Jupyter notebooks, it seems that one needs to put the shared library (`libpygkls.{so|dylib}`) in the global library path (e.g. `/usr/local/lib`), or to create a symbolic link. One can also put the shared library in the same directory as the notebook.
"
files: |
*.so
pygkls/*.so
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ To install pyGKLS, one need `Python 3.12` or later, `CMake 3.28` or later, and a
```
This will build the C++ dynamic library and the Cython package. Then, it will copy the Cython package to the Python site-packages directory and the shared library to `$HOME/.local/lib`. Make sure that `LD_LIBRARY_PATH` (or `DYLD_LIBRARY_PATH` for macOS) includes `$HOME/.local/lib`.


> [!WARNING]
> To use pyGKLS in Jupyter notebooks, it seems that one needs to put the shared library (`libpygkls.{so|dylib}`) in the global library path (e.g. `/usr/lib`), or to create a symbolic link. One can also put the shared library in the same directory as the notebook.
### Usage
The Python interface is simple and easy to use. Here is an example of how to generate a GKLS function:
```python
Expand Down

0 comments on commit 8aaa28c

Please sign in to comment.