Skip to main content

a tool for using surfaces to explore volumetric data in napari

Project description

surforama

a napari-based tool for using surfaces to explore volumetric data in napari

inspired by membranorama

Screenshot of surforama showing a surface in the slice of a tomogram

installation

First, install napari. Then install surforama in the same environment.

pip install surforama

usage

launch without data

You can launch surforama using the command line interface. After you have installed surforama, you can launch it with the following command in your terminal:

surforama

After surforama launches, you can load your image and mesh into napari and get surfing!

launch with data

If you have an MRC-formatted tomogram and an obj-formatted mesh, you can launch using the following command:

surforama --image-path /path/to/image.mrc --mesh-path /path/to/mesh.obj

developer installation

If you would like to make changes to the surforama source code, you can install surformama with the developer tools as follows:

cd /path/to/your/surforama/source/code/folder
pip install -e ".[dev]"

We use pre-commit to keep the code tidy. Install the pre-commit hooks to activate the checks:

pre-commit install

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surforama-0.0.2.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

surforama-0.0.2-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file surforama-0.0.2.tar.gz.

File metadata

  • Download URL: surforama-0.0.2.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for surforama-0.0.2.tar.gz
Algorithm Hash digest
SHA256 65b73df1446be0520b530cc4d7bfcd62a9fab1040d619d38620faaba4f72af3c
MD5 33682cdc58dfe1dff381eeb328dd2fbb
BLAKE2b-256 57fe6621723332e19d3f89ce2dab1042f1490d2e979033c9a8cfb2ccd45e5696

See more details on using hashes here.

File details

Details for the file surforama-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: surforama-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for surforama-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 355433b6b8acfb5e947b933df426e71b043988259eda20823ce0474609fd8df0
MD5 d264124c21d1d2e59a7c6e68842a1298
BLAKE2b-256 4713de9db0685949cf70324d4566330ca3ccd69dd559aa984f02a68fe96e51b7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page