https://github.com/humanbrainproject/hbp_archive
A high-level API for interacting with the Human Brain Project archival storage at CSCS
https://github.com/humanbrainproject/hbp_archive
Last synced: 6 months ago
JSON representation
A high-level API for interacting with the Human Brain Project archival storage at CSCS
- Host: GitHub
- URL: https://github.com/humanbrainproject/hbp_archive
- Owner: HumanBrainProject
- License: apache-2.0
- Created: 2018-02-06T09:53:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-03T15:58:41.000Z (over 4 years ago)
- Last Synced: 2025-09-20T21:05:06.725Z (6 months ago)
- Language: Python
- Size: 237 KB
- Stars: 4
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
A high-level API for interacting with the Human Brain Project archival storage at CSCS.
Authors: Andrew Davison (CNRS), Shailesh Appukuttan (CNRS) and Eszter Agnes Papp (University of Oslo)
Documentation: https://hbp-archive.readthedocs.io
Installation: `pip install hbp_archive`
Usage:
```python
from hbp_archive import Container, PublicContainer, Project, Archive
# Working with a public container
container = PublicContainer("https://object.cscs.ch/v1/AUTH_id/my_container")
files = container.list()
local_file = container.download("README.txt")
print(container.read("README.txt"))
number_of_files = container.count()
size_in_MB = container.size("MB")
# Working with a private container
container = Container("MyContainer", username="xyzabc") # you will be prompted for your password
files = container.list()
local_file = container.download("README.txt", overwrite=True) # default is not to overwrite existing files
print(container.read("README.txt"))
number_of_files = container.count()
size_in_MB = container.size("MB")
container.move("my_file.dat", "a_subdirectory", "new_name.dat") # move/rename file within a container
# Reading a file directly, without downloading it
with container.open("my_data.txt") as fp:
data = np.loadtxt(fp)
# Working with a project
my_proj = Project('MyProject', username="xyzabc")
container = my_proj.get_container("MyContainer")
# Listing all your projects
archive = Archive(username="xyzabc")
projects = archive.projects
container = archive.find_container("MyContainer") # will search through all projects
```
### ACKNOWLEDGEMENTS
This open source software code was developed in part or in whole in the Human Brain Project, funded from the European Union's Horizon 2020 Framework Programme for Research and Innovation under Specific Grant Agreements No. 720270, No. 785907 and No. 945539 (Human Brain Project SGA1, SGA2 and SGA3).