Metadata-Version: 2.4
Name: nanosurf-utils
Version: 2.0.7
Summary: Nanosurf utilities package - Device control, data handling, and plotting
Author-email: Nanosurf AG <scripting@nanosurf.com>
License-Expression: MIT
Project-URL: Homepage, https://www.nanosurf.com
Keywords: nanosurf,afm,utilities,data-analysis,plotting
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.15,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nanosurf-core==2.0.7
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: h5py>=3.11
Requires-Dist: matplotlib
Requires-Dist: pyside6>=6.10
Requires-Dist: pyqtgraph>=0.14
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Dynamic: license-file

# `nanosurf-utils` package

This package provides functionality for processing AFM measurement data, file
handling, and communicating with accessories and devices.

## Requirements

The library installs on Windows, Linux and macOS, but not every feature is
available on every platform:

| | Windows | Linux | macOS |
|---|---|---|---|
| Studio or MobileS functionality via Python | ✅ | – | – |
| Accessory and add-on device control | ✅ | ✅ | – |
| Reading and analyzing measurement data | ✅ | ✅ | ✅ |

## Installation and updating

To install the `nanosurf-utils` package, run the following command from your command
line interface:

```bash
pip install nanosurf-utils
```

To upgrade your `nanosurf-utils` package installation to the newest version, run the
following command from your command line interface:

```bash
pip install -U nanosurf-utils
```

> **Note:**
> If a `nanosurf` library version &lt; 2.0.0 is already installed, the library needs to be
> uninstalled first:
> ```bash
> pip uninstall nanosurf
> ```

## Documentation

The full documentation for the library and the Studio scripting interface is bundled with Nanosurf Studio starting from version 18.

## Version History

See `CHANGELOG.txt` in the installed package folder.

## License

[MIT License](https://en.wikipedia.org/wiki/MIT_License)
