Getting started with the software stack¶

For most components of LUCIstack, we provide binary builds for Windows, Linux (x64) and MacOSX (arm64). Before installing anabrid's software, make sure that a working install of Python (3.11 - 3.14) is on your machine. We recommend using the Python package manager uv -- follow its install guide for setting it up on your operating system. Most of anabrid's guide will use uv.

Release versions and public packages¶

pybrid-computing, pyredacc and lucihub-cli recently been made publicly available (source to come). Both can now be installed simply through PyPi, i.e.,

uv pip install pybrid-computing pyredacc lucihub-cli

Note that this only works with the tagged versions -- versions that our developers deliberately chose to publish. All public packages are now installed on yur system - refer to the individual documentations for their actual usage. From time to time, you'll be able to update your packages by adding the -U flag to the install command from above.

Pre-release versions and restricted-access packages¶

anabrid's internal users and cooperation partners may have access to pre-release/development versions of all packages and also to restricted packages, such as the redacc compiler.

Setup and authentication¶

In addition to python, you'll needa working Docker install. Use system packages for Linux and Docker Desktop for Windows and MacOSX (only for usage of redacc).

Here are quick tests to run in order to check the availability: - uv venv --python 3.13 && pip install numpy - docker run hello-world

Furthermore, you will need an anabrid Gitlab account and set up an API token: 1. Go to User settings (click on your portrait) and move to Personal Access Tokens 2. Click Add new token 3. Enter a self-chosen name and select the read_repository, read_virtual_registry, read_registry, read_api. permissions. 4. Note down the generated token.

In order to automatically retrieve your images, this information should be stored permanently so you avoid having to export ... this in each terminal window. In your ~/.bashrc, add the following two lines:

export CI_REGISTRY_USER=<your gitlab user name, e.g. thuerck>
export CI_REGISTRY_PASSWORD=<the token you generated above>

Alternatively, you can also add this at runtime, see the examples below.

Installing the basic software stack and running examples¶

We will now install pybrid and redacc (through its pyredacc frontend). While internal users may rely on Gitlab, a subset of the applications is also available for external users using GitHub.

First, install pybrid-computing (and its subpackage, pybrid-computing-native):

uv venv --python 3.13
uv pip install pybrid-computing --prerelease=allow --index-url https://__token__:<TOKEN>@lab.analogparadigm.com/api/v4/projects/pybrid-computing%2Fpybrid-computing/packages/pypi/simple

in which you replace <TOKEN> by your personal access token for Gitlab. Once done, you can now download and run the examples under LUCIDAC examples or use the pybrid CLI via uv run pybrid....

Next, we install the compiler's Python interface pyredacc via uv:

uv pip install pyredacc --prerelease=allow --index-url https://__token__:<TOKEN>@lab.analogparadigm.com/api/v4/projects/lucidac%2Fsoftware%2Fsoftthat/packages/pypi/simple

One possible example is the SymPy example which converts an ODE in SymPy, compiles it into a LUCIDAC-applicable format and then sets up the simulator to excute the circuit. pyredacc natively bridges into pybrid as the example shows.

Please note that pyredacc internally uses Docker to download images containing both the simulator and compiler. This may take a while, depending on the internet connection.

Updating: From time to time we're releasing new versions. It's best to update both packages by:

uv pip install -U pybrid-computing pybrid-computing-native --prerelease=allow --index-url https://__token__:<TOKEN>@lab.analogparadigm.com/api/v4/projects/pybrid-computing%2Fpybrid-computing/packages/pypi/simple
uv pip install -U pyredacc --prerelease=allow --index-url https://__token__:<TOKEN>@lab.analogparadigm.com/api/v4/projects/lucidac%2Fsoftware%2Fsoftthat/packages/pypi/simple

Troubleshooting¶

I am getting a docker.errors.APIError: 403 Client Error / denied: access forbidden for one of the downloaded images. Unclear. Try manually logging in with you Gitlab username and your token as password:

docker login lab.analogparadigm.com:5050
docker pull lab.analogparadigm.com:5050/lucidac/software/softthat/redacc-simulator:latest