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.23.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.23-py3-none-any.whl (236.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webknossos-0.9.23.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.23.tar.gz
Algorithm Hash digest
SHA256 46d06ee255fcabf90ed8e875450fb0f0896cb3e54347f56f6402d361f8ddd381
MD5 66e79c8e8198786d8ee65f21f8fe0eda
BLAKE2b-256 7b81a24b05d71c259ed52d12a67b207e6989be9099d083f6b562737227b1f0c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: webknossos-0.9.23-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.23-py3-none-any.whl
Algorithm Hash digest
SHA256 661a80289bdb79dff30fb976cc77632f28aa81c005eb665f93f9f8f2da264530
MD5 cd96678fd863a4097afbd683430f50ee
BLAKE2b-256 3673a44c8bf368200151653ec5ac58bf11f0764f4a3665aa8d911b0ec054806f

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