Contributing#

Contributions to the project are more welcome in various forms. Please see the contribution guide for details.

Code structure#

The core Arcana code base is implemented in the “arcana-core” package, which installs in the arcana.core module. Extensions which implement data store connectors and analyses are installed in separate namesapces (e.g. arcana-xnat, arcana-bids).

In each extension package, there are four special sub-packages, which will be searched by the CLI and enable definitions within them to be specified by the extension name alone, e.g. xnat:XnatApp, bids:BidsApp

  • arcana.*.analysis - Arcana analysis class definitions

  • arcana.*.cli - data space definitions (see Spaces)

  • arcana.*.data - datatype definitions (see Items)

  • arcana.*.deploy - command-line tools

Authorship#

If you contribute code, documentation or bug reports to the repository please add your name and affiliation to the Zenodo file