Skip to main content

Abstracted repository-centric analysis framework

Project description

https://travis-ci.org/MonashBI/arcana.svg?branch=master https://codecov.io/gh/MonashBI/arcana/branch/master/graph/badge.svg Supported Python versions Latest Version Documentation Status

Abstraction of Repository-Centric ANAlysis (Arcana) is Python framework for “repository-centric” analyses of study groups (e.g. NeuroImaging studies) built on Nipype.

Arcana interacts closely with a repository, storing intermediate outputs, along with the parameters used to derive them, for reuse by subsequent analyses. Repositories can either be XNAT repositories or plain file system directories, and a BIDS module is under development.

Analysis workflows are constructed and executed using the Nipype package, and can either be run locally or submitted to HPC schedulers using Nipype’s execution plugins. For a requested analysis output, Arcana determines the required processing steps by querying the repository to check for missing intermediate outputs before constructing the workflow graph. When running in an environment with Environment Modules installed, Arcana manages the loading and unloading of software modules per pipeline node.

Design

Arcana is designed with an object-oriented philosophy, with the acquired and derived data sets along with the analysis pipelines used to derive the derived data sets encapsulated within “Study” classes.

The Arcana package itself only provides the abstract Study and MultiStudy base classes, which are designed to be sub-classed to provide specialised classes representing the analysis that can be performed on specific types of data (e.g. FmriStudy, PetStudy). These specific classes can then be sub-classed further into classes that are specific to a particular study, and integrate complete analysis workflows from preprocessing to statistics.

Installation

Arcana can be installed using pip:

$ pip install arcana

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

arcana-0.3.1.tar.gz (129.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arcana-0.3.1-py2.py3-none-any.whl (158.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file arcana-0.3.1.tar.gz.

File metadata

  • Download URL: arcana-0.3.1.tar.gz
  • Upload date:
  • Size: 129.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/2.7.15

File hashes

Hashes for arcana-0.3.1.tar.gz
Algorithm Hash digest
SHA256 b397c6e622f2b80bad01e3f2d813c7f8719978be200a084f9989ea1013e03ed0
MD5 9fef6b716bf948042e5df45cf7f52704
BLAKE2b-256 ad11e068ad7a5f0c4efc6acc40108b6f46719f2887695cee1814d49b5a3f12a9

See more details on using hashes here.

File details

Details for the file arcana-0.3.1-py2.py3-none-any.whl.

File metadata

  • Download URL: arcana-0.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 158.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/2.7.15

File hashes

Hashes for arcana-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 88dec8250bdf6fe6c79136a15c4d2826a7b94d1b66d74e77e5e7319cb55866d2
MD5 bf07bb9480d402ca894383b4282dcb77
BLAKE2b-256 5614844a6981da63b300fa5f1d115325de9215280ce101c822075928c18c488c

See more details on using hashes here.

Supported by

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