Skip to main content

Python API for working with webKnossos datasets, annotations, and for webKnossos server interaction.

Project description

webKnossos Python Library

PyPI version Supported Python Versions Build Status Documentation Code Style

Python API for working with webKnossos datasets, annotations, and for webKnossos server interaction.

For the webKnossos server, please refer to https://github.com/scalableminds/webknossos.

Features

  • easy-to-use dataset API for reading/writing/editing raw 2D/3D image data and volume annotations/segmentation in webKnossos wrap (*.wkw) format
    • add/remove layers
    • update metadata (datasource-properties.json)
    • up/downsample layers
    • compress layers
    • add/remove magnifications
    • execute any of the wkCuber operations from your code
  • manipulation of webKnossos skeleton annotations (*.nml) as Python objects
    • access to nodes, comments, trees, bounding boxes, metadata, etc.
    • create new skeleton annotation from Graph structures or Python objects
  • interaction, connection & scripting with your webKnossos instance over the REST API
    • up- & downloading annotations and datasets

Please refer to the documentation for further instructions.

Installation

The webknossos package requires at least Python 3.7+.

You can install it from pypi, e.g. via pip:

pip install webknossos

Examples

See the examples folder or the the documentation.

Contributions & Development

Please see the respective documentation page.

License

AGPLv3 Copyright scalable minds

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webknossos-0.10.15.tar.gz (147.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

webknossos-0.10.15-py3-none-any.whl (275.4 kB view details)

Uploaded Python 3

File details

Details for the file webknossos-0.10.15.tar.gz.

File metadata

  • Download URL: webknossos-0.10.15.tar.gz
  • Upload date:
  • Size: 147.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.13 Linux/5.15.0-1019-azure

File hashes

Hashes for webknossos-0.10.15.tar.gz
Algorithm Hash digest
SHA256 b5af41216e9670468b242b0bb9508b13aba9c6ebbfa410b0db4bf80f6b1a9de1
MD5 5ed8370d4c0958eaa8a67eee4bd2ba93
BLAKE2b-256 313f70c51cafaf02b93e0cbfe7d8dd89018fca780ca5b952b11c3f5880e76e2d

See more details on using hashes here.

File details

Details for the file webknossos-0.10.15-py3-none-any.whl.

File metadata

  • Download URL: webknossos-0.10.15-py3-none-any.whl
  • Upload date:
  • Size: 275.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.13 Linux/5.15.0-1019-azure

File hashes

Hashes for webknossos-0.10.15-py3-none-any.whl
Algorithm Hash digest
SHA256 47648e0637014a305d6496660f17205427b2141c180014d87eb12cad3d462dae
MD5 997ec8333cc260b1e820ec24b48b9e23
BLAKE2b-256 b4cdd506d7b77e94bb3e4b5bcf0e0a787672feca519635bd2a540e343922c15d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page