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.17.tar.gz (147.9 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.17-py3-none-any.whl (282.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.10.17.tar.gz
  • Upload date:
  • Size: 147.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.14 Linux/5.15.0-1020-azure

File hashes

Hashes for webknossos-0.10.17.tar.gz
Algorithm Hash digest
SHA256 263264df288b9c523b50a8bca5f18f7c25537f73fda2d9a1f37bb64c455453b6
MD5 4cdcba6a49f17e2de7915ce9940ba6c4
BLAKE2b-256 788f603ab21c59cc49ca82bd28df91f2665d14e515c991238587aeb62cd69512

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for webknossos-0.10.17-py3-none-any.whl
Algorithm Hash digest
SHA256 31d3e18af544c5f63097f525c27a282802646c4ba24780c4caa69575cb090341
MD5 e77ff6b70ee43bb0622f233f2423ffc8
BLAKE2b-256 d4213aeb76ff9a5300c117ad05e82b85c9e6d9e06a276cb1fdb87b138181bd18

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