Metadata-Version: 2.4
Name: icepap
Version: 3.14.0
Summary: Python IcePAP Extension for Win32, Linux, BSD, Jython
Author-email: "Guifre Cuni et al." <controls@cells.es>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://gitlab.com/icepap-organization/IcePAP
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: prompt_toolkit>=3
Requires-Dist: beautifultable>=1
Requires-Dist: click>=7
Requires-Dist: numpy
Provides-Extra: simulator
Requires-Dist: sinstruments>=1.3; extra == "simulator"
Requires-Dist: motorlib>=0.1; extra == "simulator"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff>=0.14; extra == "dev"
Dynamic: license-file

# icepap

![Pypi version][pypi]

Python module to configure, control and monitor IcePAP based systems.


## Installation

From within your favourite python environment:

```console
pip install icepap
```

icepap is also available on [conda-forge](https://github.com/conda-forge/icepap-feedstock).
You can install it using [conda](https://docs.conda.io):

```console
conda install -c conda-forge icepap
```

## Documentation

The project documentation can be build it by executing:
```console
python setup.py build_sphinx
```

This documentation has been created by [sphinx](http://www.sphinx-doc.org/en/stable/).

## Simulation
This is based on [sintruments](http://github.com/tiagocoutinho/sinstruments).
It provides simulation for basic motion including jog.

Install with:
```
$ pip install icepap[simulator]
```

Make sure icepap simulator is registered:
```
$ sinstruments-server ls
[...]
IcePAP from icepap <current version #.#.#>
[...]
```

Configure a yaml file called `ice.yaml`. Example:
```yaml
    devices:
    - class: IcePAP
      name: ipap_simu
      transports:
      - type: tcp
        url: 0:5000
      axes:
      - address: 1
        velocity: 100
        name: th
      - address: 2
        name: tth
        acctime: 0.125
      - address: 11
        name: phi
      - address: 12
        name: chi
```

run server with:
```
sinstruments-server -c ./ice.yaml --log-level=debug
```
access like a "real" icepap with this python library or from cli:
```
$ nc -C localhost 5000
1:?pos
1:?pos 0
```

## Tests

You can run tests simply with:
```console
pytest
```

## Contribute

You can find how to contribute to this project on CONTRIBUTING.md file.


[pypi]: https://img.shields.io/pypi/pyversions/icepap.svg
