Skip to main content

Cloud-BIDS-Layout: Use pybids with Amazon S3

Project description

Build Status License: MIT Code style: black

Cloud-BIDS-Layout

Cloud-BIDS-Layout is a lightweight wrapper for pybids' BIDS.Layout that can grab BIDS studies from Amazon S3.

Motivation

The Brain Imaging Data Structure (BIDS) is an intuitive, accessible, and community-driven data specification for neuroimaging data. Pybids is an exceptionally written Python library that makes it easy for researchers to query, summarize, and manipulate BIDS-compliant data. However, it's workhorse BIDSLayout class doesn't index remote datasets stored in the cloud. That's where Cloud-BIDS-Layout comes in.

Cloud-BIDS-Layout allows its user to specify a remote location for a BIDS-Compliant dataset. Currently only Amazon S3 locations are supported but support for Google Cloud Storage and others is coming soon. Cloud-BIDS-Layout creates a lightweight semblance of the remote dataset, just enough to pass to pybids' BIDSLayout for indexing. The user can then use pybids' familiar .get() method to select a subset of the study that they wish to download to the host. See the documentation for more details.

This is the Cloud-BIDS-Layout development site. You can view the source code, file new issues, and contribute to Cloud-BIDS-Layouts's development. If you are just getting started, you should look at the Cloud-BIDS-Layout documentation

Contributing

We love contributions! Cloud-BIDS-Layout is open source, built on open source, and we'd love to have you hang out in our community.

We have developed some guidelines for contributing to Cloud-BIDS-Layout.

Imposter syndrome disclaimer: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

The imposter syndrome disclaimer was originally written by Adrienne Lowe for a PyCon talk, and was adapted based on its use in the README file for the MetPy project.

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

cloud_bids_layout-0.1.2.tar.gz (55.6 kB view details)

Uploaded Source

Built Distribution

cloud_bids_layout-0.1.2-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file cloud_bids_layout-0.1.2.tar.gz.

File metadata

  • Download URL: cloud_bids_layout-0.1.2.tar.gz
  • Upload date:
  • Size: 55.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for cloud_bids_layout-0.1.2.tar.gz
Algorithm Hash digest
SHA256 938661c092d728f1b066b23dedf4009f409c99c8d56f84c9c97bf41dddc08e35
MD5 8adbb552b61d35f3216eebfbfbfade8c
BLAKE2b-256 56b92b2f29fd52cb232b6bd17d81cb788b3749e8ae82f590eac804b875399f8d

See more details on using hashes here.

File details

Details for the file cloud_bids_layout-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: cloud_bids_layout-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for cloud_bids_layout-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 68c9f505b8f4f881304db6ea82d807421df3bcbcea20cfd4b642663ccecf7530
MD5 46c9b0ea56bad29938c6c3929dc22de6
BLAKE2b-256 ee73e4f967ab913105ff19ec3d48ddfdcbf55164a9f9aa44df188727bc3553c8

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