Skip to main content

CloudReg

Documentation Status License DOI

CloudReg is a tool for cross-modal, nonlinear, image registration between arbitrary image volumes.

Overview

Quantifying terascale multi-modal human and animal imaging data requires scalable analysis tools. We developed CloudReg, an automated, terascale, cloud-based image analysis pipeline for preprocessing and cross-modal, non-linear registration between volumetric datasets with artifacts. CloudReg was developed using cleared mouse and rat brain light-sheet microscopy images, but is also accurate in registering the following datasets to their respective atlases: in vivo human and ex vivo macaque brain magnetic resonance imaging, ex vivo murine brain micro-computed tomography. Our extensive documentation (below) can enable deployment of this tool for many other datasets/research questions.

Documentation

The official documentation with usage is at https://cloudreg.neurodata.io

Please visit the Run section in the official website for more in depth usage.

System Requirements

Hardware requirements

CloudReg requires only a standard computer with enough RAM to support the in-memory operations since the majority of work is run in cloud services.

Software requirements

OS Requirements

CloudReg is tested on the following OSes and requires Python 3:

  • Linux x64
  • macOS x64

Installation Guide

Please see Setup on the official website for detailed set up information.

License

This project is covered under the Apache 2.0 License.

Issues

We appreciate detailed bug reports and feature requests (though we appreciate pull requests even more!). Please visit our issues page if you have questions or ideas.

Citing CloudReg

If you find CloudReg useful in your work, please cite the tool via the CloudReg paper

Chandrashekhar, V., Tward, D.J., Crowley, D. et al. CloudReg: automatic terabyte-scale cross-modal brain volume registration. Nat Methods (2021). https://doi.org/10.1038/s41592-021-01218-z

Metadata

Release files for CloudReg 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for CloudReg 1.0.1
File Size Uploaded Provenance Actions
CloudReg-1.0.1.tar.gz 67.5 kB Without provenance Details for CloudReg-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for CloudReg 1.0.1
File Interpreter ABI Platform Actions
CloudReg-1.0.1-py3-none-any.whl Python 3 none any Details for CloudReg-1.0.1-py3-none-any.whl

Total release size: 151.7 kB

Release files / CloudReg-1.0.1.tar.gz

Download URL CloudReg-1.0.1.tar.gz
Size 67.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1685b73bf4c0e0fa52d0510542faad36a0b8048acb84950e5e21ca6aef1ce4c5
BLAKE2b-256 checksum
How to use checksums
05eae3d3b273fd28c6ef1b7d9f9f98470bf4a50c01b9ab85701179f6a43a7706
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.5

Release files / CloudReg-1.0.1-py3-none-any.whl

Download URL CloudReg-1.0.1-py3-none-any.whl
Size 84.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8f14565245a450594ae85461eeeac79ac30bc232d56dde3d9ee8bccfd0c80cf9
BLAKE2b-256 checksum
How to use checksums
b6f889d9ff3bdd40a07554dced1e7e3230f9ba4306a00586e9639ff2aea03910
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.5

Security for CloudReg 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page