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.0.tar.gz (130.4 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.0-py3-none-any.whl (248.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.10.0.tar.gz
  • Upload date:
  • Size: 130.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.13.0-1022-azure

File hashes

Hashes for webknossos-0.10.0.tar.gz
Algorithm Hash digest
SHA256 c7baba06c015858a38d74ea6c86e194cfe56e5e0d7ca624c4a43c294aafb1a8d
MD5 4b291393bc1f3a017f1819096688e8c0
BLAKE2b-256 14f6e0b0d85a2a4956977ce71b5ed15ccebcd4b18d44f8f05f513705953b85b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: webknossos-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 248.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.13.0-1022-azure

File hashes

Hashes for webknossos-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f393362575d4eb31f0411001c4ad24c018afcb244e0b98ebe4988a63b91626b
MD5 8649c4903f8f8d898fbef08b507fa503
BLAKE2b-256 df09d3cce92ad250d4ac4a2eea92f5963ef3c60da8dff07f9dd09c547f6697a0

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