rename to openlabctrl

Author: gkpau

README.md

@@ -1,4 +1,4 @@
-# Redpitaya-IO-Sync
+# OpenLabCtrl
 Library for Synchronous and Deterministic Control of Red Pitaya's Digital and Analog IOs.
 
 ## Features:
@@ -42,18 +42,18 @@ Please install the Zynq TCP Control library (TCP-based control utilities for ZYN
 ### This Library
 * Clone the Zynq TCP Control repository:
   ```
-  git clone https://github.com/dspsandbox/Redpitaya-IO-Sync/tree/main
+  git clone https://github.com/dspsandbox/openlabctrl/tree/main
   ```
 
 * Navigate to the python lib and install via pip3 (-e for editable install):
     ```
-    cd redpitaya-io-sync
+    cd openlabctrl
     python3 -m pip install --upgrade pip setuptools wheel
     pip3 install -e .
     ```
 
 ## Documentation
-See [Pyhton API Reference](https://dspsandbox.github.io/Redpitaya-IO-Sync/) (latest version).
+See [Pyhton API Reference](https://dspsandbox.github.io/openlabctrl/) (latest version).
 
 ## Examples
 |Notebook | Description|
@@ -72,7 +72,7 @@ See [Pyhton API Reference](https://dspsandbox.github.io/Redpitaya-IO-Sync/) (lat
 ![](https://redpitaya.readthedocs.io/en/latest/_images/Red_Pitaya_pinout.jpg)
 
 
-|IO Name (Redpitaya-IO-Sync library) | Pin Name (see diagram above) | Description|
+|IO Name (OpenLabCtrl library) | Pin Name (see diagram above) | Description|
 |-|-|-|
 led[0-7] | LED_0-7 | User LEDs
 digital_io_0[0] | DIO0_P (trig ext) | Digital IO (3.3V) 

doc/api/device.rst

@@ -3,15 +3,15 @@ Device
 
 RP Base
 ---------------
-.. autoclass:: redpitaya_io_sync.device.rp_base.Rp_base
+.. autoclass:: openlabctrl.device.rp_base.Rp_base
    :members:
    :undoc-members:
    :inherited-members:
    :exclude-members: MMAP_DICT, ADDR_DICT, BITSTREAM
 
 RP 125-14 Base
 ---------------
-.. autoclass:: redpitaya_io_sync.device.rp_125_14.Rp_125_14
+.. autoclass:: openlabctrl.device.rp_125_14.Rp_125_14
    :members:
    :undoc-members:
    :inherited-members:
@@ -21,7 +21,7 @@ RP 125-14 Base
 RP 125-14 Z7010
 ---------------
 
-.. autoclass:: redpitaya_io_sync.device.Rp_125_14_Z7010
+.. autoclass:: openlabctrl.device.Rp_125_14_Z7010
    :members:
    :undoc-members:
    :inherited-members:
@@ -31,7 +31,7 @@ RP 125-14 Z7010
 
 RP 125-14 Z7020
 ---------------
-.. autoclass:: redpitaya_io_sync.device.Rp_125_14_Z7020
+.. autoclass:: openlabctrl.device.Rp_125_14_Z7020
    :members:
    :undoc-members:
    :inherited-members:

doc/api/frame.rst

@@ -4,20 +4,20 @@ Frame
 Trigger Source
 --------------
 
-.. autoclass:: redpitaya_io_sync.io.sync.TriggerSource
+.. autoclass:: openlabctrl.io.sync.TriggerSource
    :members:
    :undoc-members:
 
 
 Frame Classes
 -------------
 
-.. autoclass:: redpitaya_io_sync.frame.IoSyncFrame
+.. autoclass:: openlabctrl.frame.IoSyncFrame
    :members:
    :undoc-members:
    :inherited-members:
 
-.. autoclass:: redpitaya_io_sync.frame.ParametrizedIoSyncFrame
+.. autoclass:: openlabctrl.frame.ParametrizedIoSyncFrame
    :members:
    :undoc-members:
    :inherited-members:

doc/api/io.rst

@@ -3,12 +3,12 @@ IO
 
 `Link`_ to IOs and pin mapping for Red Pitaya 125-14 devices.
 
-.. _Link: https://github.com/dspsandbox/Redpitaya-IO-Sync#ios--pin-mapping
+.. _Link: https://github.com/dspsandbox/openlabctrl#ios--pin-mapping
 
 Base IO
 -------
 
-.. autoclass:: redpitaya_io_sync.io.base.BaseIo
+.. autoclass:: openlabctrl.io.base.BaseIo
    :members:
    :undoc-members:
    :inherited-members:
@@ -17,7 +17,7 @@ Base IO
 Digital
 -------
 
-.. autoclass:: redpitaya_io_sync.io.digital.DigitalIo
+.. autoclass:: openlabctrl.io.digital.DigitalIo
    :members:
    :undoc-members:
    :inherited-members:
@@ -26,7 +26,7 @@ Digital
 Analog
 ------
 
-.. autoclass:: redpitaya_io_sync.io.analog.AnalogOut
+.. autoclass:: openlabctrl.io.analog.AnalogOut
    :members:
    :undoc-members:
    :inherited-members:
@@ -35,13 +35,13 @@ Analog
 RF
 ---
 
-.. autoclass:: redpitaya_io_sync.io.rf.RfBase
+.. autoclass:: openlabctrl.io.rf.RfBase
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
 
-.. autoclass:: redpitaya_io_sync.io.rf.RfOut
+.. autoclass:: openlabctrl.io.rf.RfOut
    :members:
    :undoc-members:
    :inherited-members:
@@ -50,12 +50,12 @@ RF
 Scope (Digital, Analog, RF acquisition)
 ---------------------------------------
 
-.. autoclass:: redpitaya_io_sync.io.scope.ScopeSource
+.. autoclass:: openlabctrl.io.scope.ScopeSource
    :members:
    :undoc-members:
 
 
-.. autoclass:: redpitaya_io_sync.io.scope.Scope
+.. autoclass:: openlabctrl.io.scope.Scope
    :members:
    :undoc-members:
    :inherited-members:
@@ -64,7 +64,7 @@ Scope (Digital, Analog, RF acquisition)
 LED
 ---
 
-.. autoclass:: redpitaya_io_sync.io.led.Led
+.. autoclass:: openlabctrl.io.led.Led
    :members:
    :undoc-members:
    :inherited-members:

doc/api/sequence.rst

@@ -1,7 +1,7 @@
 Sequence
 ========
 
-.. autoclass:: redpitaya_io_sync.sequence.IoSequence
+.. autoclass:: openlabctrl.sequence.IoSequence
    :members:
    :undoc-members:
    :show-inheritance:

doc/api/serial.rst

@@ -4,13 +4,13 @@ Serial
 SPI
 ---
 
-.. autoclass:: redpitaya_io_sync.serial.spi.SPI
+.. autoclass:: openlabctrl.serial.spi.SPI
    :members:
    :undoc-members:
 
 UART
 ----
 
-.. autoclass:: redpitaya_io_sync.serial.uart.UART
+.. autoclass:: openlabctrl.serial.uart.UART
    :members:
    :undoc-members:

doc/conf.py

@@ -236,6 +236,6 @@ def _patched_add_content(self, more_content):
 }
 
 html_theme = "furo"
-html_title = f"{project} {release}"
+html_title = f"OpenLabCtrl {release}"
 
 exclude_patterns = ["_build"]

driver/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=64", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "redpitaya_io_sync"
+name = "openlabctrl"
 version = "1.0.0"
 authors = [
     {name = "Pau Gómez", email = "pau.gomez@dspsandbox.org"},
@@ -19,4 +19,4 @@ package-dir = {"" = "src"}
 where = ["src"]
 
 [tool.setuptools.package-data]
-redpitaya_io_sync = ["bitstream/*.bit"]
+openlabctrl = ["bitstream/*.bit"]