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

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.10.7.tar.gz
  • Upload date:
  • Size: 143.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.13 Linux/5.13.0-1031-azure

File hashes

Hashes for webknossos-0.10.7.tar.gz
Algorithm Hash digest
SHA256 46267620b4718fe5e79920ca88df94e5e1b6dfa4d9fdcbd5f2d6bb389d54e2a2
MD5 fa60e20adc860800124eccac980c40f7
BLAKE2b-256 aa1343bc7e84f1ef4930f9cfaa7dd4b856ae62a33fab125ff0fe760d79b72c69

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for webknossos-0.10.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f704fc968926c6a2bd8b7c2662b554d3e4e22e3ce1e0baa8d0381a34c0ff1f25
MD5 826e15b1d7cbe94f443801d60d042508
BLAKE2b-256 15426139bbb9a1d4956a0dcccf79f89d9dc83aa7120d374c27b6d2df4d8c1084

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