Skip to main content

Library containing command lines and tools to compute placement hints

Project description

banner

Overview

This project contains tools to compute placement hints. Placement hints are used by the placement algorithm to place 3D cells in the context of circuit building.

After installation, you can display the available command lines with the following bash command:

atlas-placement-hints --help

Installation

This python project depends on Ultraliser for the algorithms which follow a mesh-based approach.

Once Ultraliser is installed, run the following bash commands:

pip install atlas-placement-hints

Examples

To generate the placement hints datasets for the isocortex, one can do the following:

Note that the required datasets under data/* can be generated by following the example in atlas-splitter.

Also note, depending on the resolution of the volume, this may require significant amounts of available RAM).

atlas-placement-hints isocortex                              \
  --hierarchy-path data/ccfv3/split_hierarcy.json            \
  --annotation-path data/ccfv3/split_annotations.nrrd        \
  --direction-vectors-path data/ccfv3/direction_vectors.nrrd \
  --algorithm voxel-based                                    \
  --output-dir data/

Instructions for developers

Run the following commands before submitting your code for review:

cd atlas-placement-hints
isort -l 100 --profile black atlas_placement_hints tests setup.py
black -l 100 atlas_placement_hints tests setup.py

These formatting operations will help you pass the linting check testenv:lint defined in tox.ini.

Citation

When you use this software, we kindly ask you to cite the following DOI:

https://zenodo.org/badge/451806240.svg

Acknowledgements

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

For license and authors, see LICENSE.txt and AUTHORS.txt respectively.

Copyright (c) 2022-2024 Blue Brain Project/EPFL

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

atlas-placement-hints-0.1.4.tar.gz (108.0 kB view details)

Uploaded Source

File details

Details for the file atlas-placement-hints-0.1.4.tar.gz.

File metadata

  • Download URL: atlas-placement-hints-0.1.4.tar.gz
  • Upload date:
  • Size: 108.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for atlas-placement-hints-0.1.4.tar.gz
Algorithm Hash digest
SHA256 b088d81f332e6157d7b9ff93683eb94df2a8e229033431001ca9a965d0549a5d
MD5 43c18608ea6b43805f7cba43954d31f7
BLAKE2b-256 2a0554e5ebd5b572a298c5ee17e19ea7901bc627495a5ce7d13e830064ef5f3c

See more details on using hashes here.

Provenance

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