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 for Python 3 using pip:

$ pip3 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.4.12.tar.gz (137.2 kB view details)

Uploaded Source

Built Distribution

arcana-0.4.12-py2.py3-none-any.whl (166.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for arcana-0.4.12.tar.gz
Algorithm Hash digest
SHA256 e247a8651a11b79ed8a18ba2d883716130b4f65086894a9431f8a0142ced9e68
MD5 a5210a35c6fa8264ae7a913fd988f812
BLAKE2b-256 937f78087ce017b7af5681744b27dcad716760eada2695e624fecd6c6200d40b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arcana-0.4.12-py2.py3-none-any.whl
  • Upload date:
  • Size: 166.3 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.8.0 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/2.7.16

File hashes

Hashes for arcana-0.4.12-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 446363c1cc8f351b8a4bb21e8ab5902a4f3eb4dcc67bf6e5a021b9c9a5ddde11
MD5 50e1f7f8c49c0f8340f956ff3e214869
BLAKE2b-256 8c0dca1d90a2e08a510b345040d0231b8b7a953b48d43c0896d7799334fe24ea

See more details on using hashes here.

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