https://github.com/arve0/leicascanningtemplate

convenience library for talking with leica matrix screener scanning template
https://github.com/arve0/leicascanningtemplate

Last synced: 8 days ago
JSON representation

convenience library for talking with leica matrix screener scanning template

• Host: GitHub
• URL: https://github.com/arve0/leicascanningtemplate
• Owner: arve0
• License: mit
• Created: 2015-03-08T22:35:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-04T17:18:09.000Z (over 6 years ago)
• Last Synced: 2024-11-05T13:48:11.708Z (15 days ago)
• Language: Python
• Size: 43.9 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# leicascanningtemplate

[![build-status-image]][travis]

[![pypi-version]][pypi]

## Overview

Convenience library for talking with Leica matrix screener scanning

template XMLs.

## Installation

Install using `pip`...

```bash

pip install leicascanningtemplate

```

## Example

```python

from leicaleicascanningtemplate import ScanningTemplate

tmpl = ScanningTemplate('path/to/scantempl.xml')

tmpl.add_well(well_x=2, well_y=3, start_x=30e-3, start_y=44e-3)

tmpl.write()

# x stage position of field

print(tmpl.field(well_x=1, well_y=1, field_x=1, field_y=1).FieldXCoordinate)

```

Read more on available elements and attributes in

[SCANNINGTEMPLATE.md](SCANNINGTEMPLATE.md).

## Documentation

Read about available commands in the API reference:

http://leicascanningtemplate.rtfd.org/

## Development

Install dependencies and link development version of leicascanningtemplate

to pip:

```bash

pip install -r dev-requirements.txt

./setup.py develop

```

### Testing

```bash

tox

```

### Build documentation locally

To build the documentation:

```bash

pip install -r docs/requirements.txt

make docs

```

[build-status-image]: https://secure.travis-ci.org/arve0/leicascanningtemplate.png?branch=master

[travis]: http://travis-ci.org/arve0/leicascanningtemplate?branch=master

[pypi-version]: https://img.shields.io/pypi/v/leicascanningtemplate.svg

[pypi]: https://pypi.python.org/pypi/leicascanningtemplate