|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:
.. code-block:: bash
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:
.. code-block:: bash
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).
.. code-block:: bash
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:
.. code-block:: bash
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:
.. image:: https://zenodo.org/badge/451806240.svg
:target: https://zenodo.org/badge/latestdoi/451806240
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
.. _Ultraliser: https://github.com/BlueBrain/Ultraliser
.. _`atlas-splitter`: https://github.com/BlueBrain/atlas-splitter
.. substitutions
.. |banner| image:: doc/source/static/atlas-placement-hints.jpg
Raw data
{
"_id": null,
"home_page": "https://github.com/BlueBrain/atlas-placement-hints",
"name": "atlas-placement-hints",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": null,
"keywords": null,
"author": "Blue Brain Project, EPFL",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5e/ac/906fad30ea7c5a11bb7031d9abb37d34c09bd81c8b762b50349f1f2c12ac/atlas-placement-hints-0.1.3.tar.gz",
"platform": null,
"description": "|banner|\n\nOverview\n=========\n\nThis project contains tools to compute placement hints.\nPlacement hints are used by the placement algorithm to place 3D cells in the context of circuit building.\n\nAfter installation, you can display the available command lines with the following ``bash`` command:\n\n.. code-block:: bash\n\n atlas-placement-hints --help\n\nInstallation\n============\n\nThis python project depends on Ultraliser_ for the algorithms which follow a mesh-based approach.\n\nOnce Ultraliser_ is installed, run the following ``bash`` commands:\n\n.. code-block:: bash\n\n pip install atlas-placement-hints\n\nExamples\n========\n\nTo generate the placement hints datasets for the isocortex, one can do the following:\n\nNote that the required datasets under `data/*` can be generated by following the example in `atlas-splitter`_.\n\nAlso note, depending on the resolution of the volume, this may require significant amounts of available RAM).\n\n.. code-block:: bash\n\n atlas-placement-hints isocortex \\\n --hierarchy-path data/ccfv3/split_hierarcy.json \\\n --annotation-path data/ccfv3/split_annotations.nrrd \\\n --direction-vectors-path data/ccfv3/direction_vectors.nrrd \\\n --algorithm voxel-based \\\n --output-dir data/\n\nInstructions for developers\n===========================\n\nRun the following commands before submitting your code for review:\n\n.. code-block:: bash\n\n cd atlas-placement-hints\n isort -l 100 --profile black atlas_placement_hints tests setup.py\n black -l 100 atlas_placement_hints tests setup.py\n\nThese formatting operations will help you pass the linting check `testenv:lint` defined in `tox.ini`.\n\nCitation\n========\n\nWhen you use this software, we kindly ask you to cite the following DOI:\n\n.. image:: https://zenodo.org/badge/451806240.svg\n :target: https://zenodo.org/badge/latestdoi/451806240\n\nAcknowledgements\n================\n\nThe development of this software was supported by funding to the Blue Brain Project, a research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government\u2019s ETH Board of the Swiss Federal Institutes of Technology.\n\nFor license and authors, see LICENSE.txt and AUTHORS.txt respectively.\n\nCopyright (c) 2022-2024 Blue Brain Project/EPFL\n\n.. _Ultraliser: https://github.com/BlueBrain/Ultraliser\n.. _`atlas-splitter`: https://github.com/BlueBrain/atlas-splitter\n\n.. substitutions\n\n.. |banner| image:: doc/source/static/atlas-placement-hints.jpg",
"bugtrack_url": null,
"license": "Apache-2",
"summary": "Library containing command lines and tools to compute placement hints",
"version": "0.1.3",
"project_urls": {
"Download": "https://github.com/BlueBrain/atlas-placement-hints",
"Homepage": "https://github.com/BlueBrain/atlas-placement-hints"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5eac906fad30ea7c5a11bb7031d9abb37d34c09bd81c8b762b50349f1f2c12ac",
"md5": "ecd8d132e404efd3657cd3f26c0099c9",
"sha256": "707570e5a7802644250058b904107f726277c2b3259042ab4ab8608549a0db91"
},
"downloads": -1,
"filename": "atlas-placement-hints-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "ecd8d132e404efd3657cd3f26c0099c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 107950,
"upload_time": "2024-06-12T12:16:18",
"upload_time_iso_8601": "2024-06-12T12:16:18.263974Z",
"url": "https://files.pythonhosted.org/packages/5e/ac/906fad30ea7c5a11bb7031d9abb37d34c09bd81c8b762b50349f1f2c12ac/atlas-placement-hints-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 12:16:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBrain",
"github_project": "atlas-placement-hints",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "atlas-placement-hints"
}
JSON
