Metadata-Version: 2.1
Name: datashuttle
Version: 0.1.0rc2
Summary: Organise and transfer scientific projects in BIDS format
Author-email: Joe Ziminski <j.ziminski@ucl.ac.uk>, Adam Tyson <code@adamltyson.com>, Niko Sirmpilatze <niko.sirbiladze@gmail.com>
License: BSD-3-Clause
Project-URL: homepage, https://github.com/neuroinformatics-unit/datashuttle
Project-URL: bug_tracker, https://github.com/neuroinformatics-unit/datashuttle/issues
Project-URL: documentation, https://github.com/neuroinformatics-unit/datashuttle
Project-URL: source_code, https://github.com/neuroinformatics-unit/datashuttle
Project-URL: user_support, https://github.com/neuroinformatics-unit/datashuttle/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# DataShuttle

Datashuttle is a work in progress as has not been officially released. It is not ready for use
as documented, please await first official release.

Datashuttle includes tools for automated generation and transfer of neuroscience project folders formatted to the [SWC-BIDS specification](https://swc-bids.neuroinformatics.dev/).

* Manage files across multiple data-collection computers by synchronising all data to with a centrally stored project.

* Simplify data transfers by selecting only a sub-set of data to move (e.g. specific subjects, sessions or data types)

See the [Documentation Page] for more information, including how to [Get Started]

## Installation

DataShuttle is hosted on  [PyPI](https://pypi.org/project/datashuttle/) and can be installed with pip.

`pip install datashuttle`

Datashuttle required Rclone for data transfers. The easiest way to install Rclone is using [Miniconda](https://docs.conda.io/en/main/miniconda.html):

```
conda install -c conda-forge rclone
```

See [the Rclone website](https://rclone.org/install/) for alternative installation methods.

## SWC-BIDS Folder Tree

DataShuttle project folders are managed according to SWC-BIDS (example below).
See the SWC-BIDS [specification](https://swc-bids.neuroinformatics.dev/) for more details.

```
└── project_name/
    └── raw_data/
        ├── sub-001/
        │   └── ses-001/
        │   │   ├── ephys/
        │   │   └── behav/
        │   └── histology/
        └── sub-002/
            └── ses-001/
            │   ├── behav/
            │   └── imaging/
            └── ses-002/
            │   └── behav/
            └── histology/
```


```+
└── project_name/
    └── rawdata/
        ├── sub-001  /
        │   ├── ses-001/
        │   │   ├── ephys
        │   │   └── behav
        │   └── histology
        └── sub-002/
            ├── ses-001/
            │   ├── behav
            │   └── imaging
            ├── ses-002/
            │   └── behav
            └── histology
```
