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

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.10.10.tar.gz
  • Upload date:
  • Size: 143.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.13 Linux/5.15.0-1014-azure

File hashes

Hashes for webknossos-0.10.10.tar.gz
Algorithm Hash digest
SHA256 ed618e054d68f660f651b7051adfda7f03b68f41da31d2b88c71f3b1f7215834
MD5 b00fcdcd7c48446bec7f6a34f4e8a996
BLAKE2b-256 2c3513f8ea73034a2f5140594c377256bdaf1006999dce0ba83e1c3148b625d4

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for webknossos-0.10.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f89836a998ac4e909ad7460521eb0ebba7024cec65d4bdfe12bb97f8d3f0dfd3
MD5 f416a149ac0e8d45c6c2772c8afe2e88
BLAKE2b-256 9963e5e89161bd6566924815358b3e824db8c6731658175497ca020ffa9ae9b7

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