Skip to content

Commit

Permalink
Merge pull request #64 from labstreaminglayer/rename_pylsl
Browse files Browse the repository at this point in the history
rename repo to pylsl
  • Loading branch information
cboulay authored Feb 14, 2023
2 parents 3992f2b + f6761cb commit 001966b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pylsl

[![Build status](https://ci.appveyor.com/api/projects/status/ggouc09585l2518i/branch/master?svg=true)](https://ci.appveyor.com/project/cboulay/liblsl-python/branch/master)
![publish workflow](https://github.com/labstreaminglayer/pylsl/actions/workflows/publish-to-pypi.yml/badge.svg)
[![PyPI version](https://badge.fury.io/py/pylsl.svg)](https://badge.fury.io/py/pylsl)

This is the Python interface to the [Lab Streaming Layer (LSL)](https://github.com/sccn/labstreaminglayer).
Expand Down Expand Up @@ -32,9 +32,9 @@ For several distributions, the pip distribution ships with lsl.dll. For every ot

## Self-built

* Download the pylsl source: `git clone https://github.com/labstreaminglayer/liblsl-Python.git && cd liblsl-Python`
* Copy the shared object (see Prerequisites above) into `liblsl-Python/pylsl/lib`.
* From the `liblsl-Python` working directory, run `pip install .`.
* Download the pylsl source: `git clone https://github.com/labstreaminglayer/pylsl.git && cd pylsl`
* Copy the shared object (see Prerequisites above) into `pylsl/pylsl/lib`.
* From the `pylsl` working directory, run `pip install .`.
* Note: You can use `pip install -e .` to install while keeping the files in-place. This is convenient for developing pylsl.

# Usage
Expand All @@ -47,7 +47,7 @@ You can get a list of the examples with `python -c "import pylsl.examples; help(

See the note above about separately installing the liblsl dependency on non-Windows platforms. `pylsl` will search for liblsl first in the package directory (default location for Windows), then in normal system library folders, then finally at the filepath specified by an environment variable named `PYLSL_LIB`. A user-installed liblsl will typically be findable by Python's `util.find_library` in most cases.

If `pylsl` cannot find the liblsl binary (e.g., see [this issue](https://github.com/labstreaminglayer/liblsl-Python/issues/48)), set the `PYLSL_LIB` environment variable to the location of the library or set `LD_LIBRARY_PATH` to the folder containing the library. i.e.,
If `pylsl` cannot find the liblsl binary (e.g., see [this issue](https://github.com/labstreaminglayer/pylsl/issues/48)), set the `PYLSL_LIB` environment variable to the location of the library or set `LD_LIBRARY_PATH` to the folder containing the library. i.e.,

`LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib python -m pylsl.examples.{name-of-example}`

Expand Down Expand Up @@ -83,7 +83,7 @@ When we did make manylinux distributions, these relied on special liblsl builds
# Known Issues with Multithreading on Linux

* At least for some versions of pylsl , is has been reported that running on Linux one cannot call ``pylsl`` functions from a thread that is not the main thread. This has been reported to cause access violations, and can occur during pulling from an inlet, and also from accessing an inlets info structure in a thread.
* Recent tests with mulithreading (especially when safeguarding library calls with locks) using Python 3.7.6. with pylsl 1.14 on Linux Mint 20 suggest that this issue is solved, or at least depends on your machine. See https://github.com/labstreaminglayer/liblsl-Python/issues/29
* Recent tests with mulithreading (especially when safeguarding library calls with locks) using Python 3.7.6. with pylsl 1.14 on Linux Mint 20 suggest that this issue is solved, or at least depends on your machine. See https://github.com/labstreaminglayer/pylsl/issues/29

# Acknowledgments

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def get_tag(self):
long_description_content_type="text/markdown",

# The project's main homepage.
url='https://github.com/labstreaminglayer/liblsl-Python',
url='https://github.com/labstreaminglayer/pylsl',

# Author details
author='Christian Kothe',
Expand Down

0 comments on commit 001966b

Please sign in to comment.