Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 2.57 KB

installation.rst

File metadata and controls

84 lines (56 loc) · 2.57 KB

Installation

Install the absscpi package from PyPI with pip or similar:

$ pip install absscpi

The Python library depends on the native C/C++ library. For instructions on installing it, see :ref:`native-installation`.

C/C++ driver installation

This library depends on the native C/C++ library. First, download the appropriate zip file for your platform or the Windows MSI installer from the latest release.

Windows

The simplest way to install the drivers on Windows is to use the MSI installer. This will by default install the library to :file:`C:/Program Files [(x86)]/Bloomy Controls/absscpi`. The Python library will find it automatically.

If you do not have administrator privileges or would prefer not to place files in :file:`System32` for some other reason, you may place the DLLs wherever you like using the zip archive download option. For details, see :ref:`custom-location`.

Linux

For most systems, directly copying the downloaded directories into :file:`/usr/local` should do the trick. It's not advised to directly install the driver into :file:`/usr`, as your system package manager should be in charge of that. For example:

$ sudo cp -r include lib* /usr/local/

If you wish to install the library to a custom location, see :ref:`custom-location`.

Using a custom install location

If you choose to install the library to a custom location and :func:`~absscpi.ScpiClient` doesn't automatically find it, you can manually tell it where you put the library. For example:

.. tab:: Windows

   .. code-block:: python

      with ScpiClient(lib="C:/Users/me/path/to/absscpi.dll") as client:
          pass



.. tab:: Linux

   .. code-block:: python

      with ScpiClient(lib="/home/me/path/to/libabsscpi.so") as client:
          pass

Linux alternative: using LD_LIBRARY_PATH

On Linux, there is an alternative to the above example which leaves your Python code unchanged (and therefore keeps it portable) but still allows you to install the library wherever you please: LD_LIBRARY_PATH.

As long as the directory containing :file:`libabsscpi.so` is present in the LD_LIBRARY_PATH environment variable, :func:`~absscpi.ScpiClient` should be able to find it and load it automatically.

For more information, see :manpage:`ld.so(8)`.