From 294a95f1215c4f0d662e0a2de1f23c261a16565f Mon Sep 17 00:00:00 2001 From: "Pfitzer, Julia" Date: Tue, 23 Apr 2024 11:23:57 +0200 Subject: [PATCH] Fixed filenames, updated README. --- .github/workflows/python-publish_musllinux.yml | 2 +- ...opy.yml => python-publish_sdist_manylinux.yml} | 2 +- README.md | 15 ++++++++++++++- 3 files changed, 16 insertions(+), 3 deletions(-) rename .github/workflows/{python-publish_sdist_manylinux copy.yml => python-publish_sdist_manylinux.yml} (95%) diff --git a/.github/workflows/python-publish_musllinux.yml b/.github/workflows/python-publish_musllinux.yml index b4008ed..8c022f6 100644 --- a/.github/workflows/python-publish_musllinux.yml +++ b/.github/workflows/python-publish_musllinux.yml @@ -1,4 +1,4 @@ -name: Build, Test, and Upload Python Package +name: Build, Test, and Upload Python Package (musllinux) on: push: diff --git a/.github/workflows/python-publish_sdist_manylinux copy.yml b/.github/workflows/python-publish_sdist_manylinux.yml similarity index 95% rename from .github/workflows/python-publish_sdist_manylinux copy.yml rename to .github/workflows/python-publish_sdist_manylinux.yml index dd50838..55aa5fa 100644 --- a/.github/workflows/python-publish_sdist_manylinux copy.yml +++ b/.github/workflows/python-publish_sdist_manylinux.yml @@ -1,4 +1,4 @@ -name: Build, Test, and Upload Python Package +name: Build, Test, and Upload Python Package (sdist and manylinux) on: push: diff --git a/README.md b/README.md index a7be20b..10ea2c3 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,19 @@ python3 -m venv venv source venv/bin/activate ``` +You can install the Python bindings using pip: + +```bash +pip install lime-driver +``` + +Alternatively you can clone the repository and install the Python bindings from source: + +```bash +git clone +cd LimeDriverBindings +``` + Ensure that the LimeDriver submodule is initialized: ```bash @@ -51,7 +64,7 @@ import limedriver Npulses = 1000 # Create a new PyLimeConfig object -config = limedriver.PyLimeConfig(Npulses) +config = limedriver.binding.PyLimeConfig(Npulses) # Modify the config as needed config.srate = 1e6