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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for webknossos-0.10.3.tar.gz
Algorithm Hash digest
SHA256 1b229743fa58b29e309d74833e1760c5dba8c171ec9c723bf97a554288cbfde7
MD5 9ab0a93a45e504cb6d54315f7508c7bf
BLAKE2b-256 4fdc18b408499422df52bb7b3cdf4999c881c5041b41effbf4e83563a08e75de

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for webknossos-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 301d210a7be3b1073e44ff1b50a16e4be2973a0c0abb4585142b04fd90d7e66e
MD5 841c80d39d5dbbe3b7d40f3c639ae087
BLAKE2b-256 93c91c2c1315d3540456ff5612975228db52314849deb348a2232dd3504627b4

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