semvec/pypi-packages huggingface dataset:
attopy 0.0.1
Abstraction layer for controlling Attocube NV magnetometer setup.
Requires Python: >=3.6

# attopy Package

This package provides hardware abstractions for interfacing the components of
the NV magnetometer/microscope.


## How to install

To install from the github repository, run the following command:

```bash
python -m pip install git+https://github.com/uni-leipzig-sum/attopy.git
```

Most modules use a visa library to communicate with instruments. The
RSInstrument package is used if available, otherwise the pyvisa package is used
as a fallback. To install RSInstrument, run the following command:

```bash
python -m pip install rsinstrument
```

A vendor Visa implementation, such as NI VISA or R&S VISA are highly recommended
(see below). As a fallback, the python implementation provided by pyvisa is
used.

The attopy package requires some platform specific libraries and drivers in
order to work properly:

### Linux

For the NI cards to work, a driver is required. On a linux OS, you need to
install the [comedi](http://comedi.org/) driver. This driver comes with python
bindings that need to be installed in your python environment. Please refer to
the [documentation](https://www.comedi.org/doc/languagebindings.html).

Alternatively, NI provides packages for [Linux device
drivers](https://www.ni.com/de-de/support/downloads/drivers/download.ni-linux-device-drivers.html#350003),
including DAQmx and Visa libraries. Note: These drivers have not been tested on
Linux OS.

### Windows

For the NI cards to work, a driver is required. NI provides the
[DAQmx](https://www.ni.com/de-de/support/downloads/drivers/download.ni-daqmx.html#382067)
set of drivers and tools along with python drivers
[nidaqmx-python](https://nidaqmx-python.readthedocs.io/en/latest/index.html). On
Windows OS, this is the best choice.

For most modules, attopy requires a visa library. Several libraries are available, such as
- [NI VISA](https://www.ni.com/de-de/support/downloads/drivers/download.ni-visa.html#346210)
- [RS VISA](https://www.rohde-schwarz.com/de/applikationen/r-s-visa-application-note_56280-148812.html)