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

Project details


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.9.24.tar.gz (126.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.9.24-py3-none-any.whl (236.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.9.24.tar.gz
  • Upload date:
  • Size: 126.1 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.9.24.tar.gz
Algorithm Hash digest
SHA256 3965447881dc1c46842b308c07d8be099a3b2ae119d16baaaf49f4d491ae6fa3
MD5 eb217c09943ad3779386926c0e5163e2
BLAKE2b-256 c938ff5cb3dddde655c6d9013c98aa0a609b574bf056ad5f74822816be6d450f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: webknossos-0.9.24-py3-none-any.whl
  • Upload date:
  • Size: 236.3 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.9.24-py3-none-any.whl
Algorithm Hash digest
SHA256 128f9bcbec480194072ffdb4b8a4035954872888c3d29f447e21dcb223f44ee1
MD5 84d3496bf5e9fb9bfd862f82ffe6d56c
BLAKE2b-256 dfaa42e1160520c296c54efccb022e37277ef9445043304a6009144c951cf790

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