| Name | arcana-dirtree JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | |
| Summary | An Arcana extension implementing a general purpose directory tree data store |
| upload_time | 2022-12-26 23:29:00 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
arcana
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Arcana Extension - DirTree
==========================
.. image:: https://github.com/ArcanaFramework/arcana-dirtree/actions/workflows/tests.yml/badge.svg
:target: https://github.com/ArcanaFramework/arcana-dirtree/actions/workflows/tests.yml
.. image:: https://codecov.io/gh/ArcanaFramework/arcana-dirtree/branch/main/graph/badge.svg?token=UIS0OGPST7
:target: https://codecov.io/gh/ArcanaFramework/arcana-dirtree
.. image:: https://readthedocs.org/projects/arcana/badge/?version=latest
:target: http://arcana.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
This Arcana extension provides a data store for operating on loosely structured data stored within sub-directories
of a file-system directory. The only constraints on the structure of the sub-directories is that the leaves of the
tree, the collected data points, are of equal depth, and each directory layer corresponds to a different classifier.
For example, an imaging dataset with multiple subjects scanned at multiple time-points could be layed out as
.. code-block::
imaging-dataset
├── subject1
│ ├── timepoint1
│ │ ├── t1w_mprage
│ │ ├── t2w_space
│ │ └── bold_rest
│ └── timepoint2
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
├── subject2
│ ├── timepoint1
│ │ ├── t1w_mprage
│ │ ├── t2w_space
│ │ └── bold_rest
│ └── timepoint2
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
└── subject3
├── timepoint1
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
└── timepoint2
├── t1w_mprage
├── t2w_space
└── bold_rest
with the classification hierarchy of ``subject > timepoint``
However, the same dataset could alternatively be layed out in the reverse
classification hierarchy, ``timepoint > subject``
.. code-block::
imaging-dataset
├── timepoint1
│ ├── subject1
│ │ ├── t1w_mprage
│ │ ├── t2w_space
│ │ └── bold_rest
| ├── subject2
│ │ ├── t1w_mprage
│ │ ├── t2w_space
│ │ └── bold_rest
│ └── subject3
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
└── timepoint2
├── subject1
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
├── subject2
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
└── subject3
├── t1w_mprage
├── t2w_space
└── bold_rest
or in a single level directory structure where the classifiers are combined to form the
sub-directory names
.. code-block::
imaging-dataset
├── sub1-tp1
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
├── sub2-tp1
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
├── sub3-tp1
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
├── sub1-tp2
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
├── sub2-tp2
│ ├── t1w_mprage
│ ├── t2w_space
│ └── bold_rest
└── sub3-tp2
├── t1w_mprage
├── t2w_space
└── bold_rest
Quick Installation
------------------
This extension can be installed for Python 3 using *pip*::
$ pip3 install arcana-dirtree
This will also install the core Arcana_ package and any required dependencies.
License
-------
This work is licensed under a
`Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`_
.. image:: https://i.creativecommons.org/l/by/4.0/88x31.png
:target: http://creativecommons.org/licenses/by/4.0/
:alt: Creative Commons Attribution 4.0 International License
.. _Arcana: http://arcana.readthedocs.io
Raw data
{
"_id": null,
"home_page": "",
"name": "arcana-dirtree",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"Thomas G. Close\" <tom.g.close@gmail.com>",
"keywords": "arcana",
"author": "",
"author_email": "\"Thomas G. Close\" <tom.g.close@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/74/2f4f87cf4420191825fdd1b3f7eeba8dd114518a529a3775d3fac9f221ab/arcana-dirtree-0.2.4.tar.gz",
"platform": null,
"description": "Arcana Extension - DirTree\n==========================\n.. image:: https://github.com/ArcanaFramework/arcana-dirtree/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/ArcanaFramework/arcana-dirtree/actions/workflows/tests.yml\n.. image:: https://codecov.io/gh/ArcanaFramework/arcana-dirtree/branch/main/graph/badge.svg?token=UIS0OGPST7\n :target: https://codecov.io/gh/ArcanaFramework/arcana-dirtree\n.. image:: https://readthedocs.org/projects/arcana/badge/?version=latest\n :target: http://arcana.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\nThis Arcana extension provides a data store for operating on loosely structured data stored within sub-directories\nof a file-system directory. The only constraints on the structure of the sub-directories is that the leaves of the\ntree, the collected data points, are of equal depth, and each directory layer corresponds to a different classifier.\nFor example, an imaging dataset with multiple subjects scanned at multiple time-points could be layed out as\n\n.. code-block::\n\n imaging-dataset\n \u251c\u2500\u2500 subject1\n \u2502 \u251c\u2500\u2500 timepoint1\n \u2502 \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2502 \u2514\u2500\u2500 bold_rest\n \u2502 \u2514\u2500\u2500 timepoint2\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u251c\u2500\u2500 subject2\n \u2502 \u251c\u2500\u2500 timepoint1\n \u2502 \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2502 \u2514\u2500\u2500 bold_rest\n \u2502 \u2514\u2500\u2500 timepoint2\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u2514\u2500\u2500 subject3\n \u251c\u2500\u2500 timepoint1\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u2514\u2500\u2500 timepoint2\n \u251c\u2500\u2500 t1w_mprage\n \u251c\u2500\u2500 t2w_space\n \u2514\u2500\u2500 bold_rest\n\nwith the classification hierarchy of ``subject > timepoint``\n\nHowever, the same dataset could alternatively be layed out in the reverse\nclassification hierarchy, ``timepoint > subject``\n\n.. code-block::\n\n imaging-dataset\n \u251c\u2500\u2500 timepoint1\n \u2502 \u251c\u2500\u2500 subject1\n \u2502 \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2502 \u2514\u2500\u2500 bold_rest\n | \u251c\u2500\u2500 subject2\n \u2502 \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2502 \u2514\u2500\u2500 bold_rest\n \u2502 \u2514\u2500\u2500 subject3\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u2514\u2500\u2500 timepoint2\n \u251c\u2500\u2500 subject1\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u251c\u2500\u2500 subject2\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest \n \u2514\u2500\u2500 subject3\n \u251c\u2500\u2500 t1w_mprage\n \u251c\u2500\u2500 t2w_space\n \u2514\u2500\u2500 bold_rest\n\n\nor in a single level directory structure where the classifiers are combined to form the\nsub-directory names\n\n.. code-block::\n\n imaging-dataset\n \u251c\u2500\u2500 sub1-tp1\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u251c\u2500\u2500 sub2-tp1\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u251c\u2500\u2500 sub3-tp1\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u251c\u2500\u2500 sub1-tp2\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest\n \u251c\u2500\u2500 sub2-tp2\n \u2502 \u251c\u2500\u2500 t1w_mprage\n \u2502 \u251c\u2500\u2500 t2w_space\n \u2502 \u2514\u2500\u2500 bold_rest \n \u2514\u2500\u2500 sub3-tp2\n \u251c\u2500\u2500 t1w_mprage\n \u251c\u2500\u2500 t2w_space\n \u2514\u2500\u2500 bold_rest\n\n\nQuick Installation\n------------------\n\nThis extension can be installed for Python 3 using *pip*::\n\n $ pip3 install arcana-dirtree\n\nThis will also install the core Arcana_ package and any required dependencies.\n\nLicense\n-------\n\nThis work is licensed under a\n`Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`_\n\n.. image:: https://i.creativecommons.org/l/by/4.0/88x31.png\n :target: http://creativecommons.org/licenses/by/4.0/\n :alt: Creative Commons Attribution 4.0 International License\n\n\n\n.. _Arcana: http://arcana.readthedocs.io\n\n",
"bugtrack_url": null,
"license": "",
"summary": "An Arcana extension implementing a general purpose directory tree data store",
"version": "0.2.4",
"split_keywords": [
"arcana"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "96568b6a3437547ac80dca40a23177f6",
"sha256": "5b6f94bc3dad95b9f531f28db8949095d8ed8fd080803ed686a2c449be4c929d"
},
"downloads": -1,
"filename": "arcana_dirtree-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96568b6a3437547ac80dca40a23177f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13509,
"upload_time": "2022-12-26T23:28:59",
"upload_time_iso_8601": "2022-12-26T23:28:59.205501Z",
"url": "https://files.pythonhosted.org/packages/62/6c/625210beb98dcba87fc2c34b1e117401c3778b0c8715fc50607e07d59109/arcana_dirtree-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "5a01620545d6ea04d354608bcb2cb539",
"sha256": "98006e90d13506e77a12f8b1f3f3df7658ef2610c9dbbc575da636657813bc0b"
},
"downloads": -1,
"filename": "arcana-dirtree-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "5a01620545d6ea04d354608bcb2cb539",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13025,
"upload_time": "2022-12-26T23:29:00",
"upload_time_iso_8601": "2022-12-26T23:29:00.824891Z",
"url": "https://files.pythonhosted.org/packages/fa/74/2f4f87cf4420191825fdd1b3f7eeba8dd114518a529a3775d3fac9f221ab/arcana-dirtree-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-26 23:29:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "arcana-dirtree"
}
