Metadata-Version: 2.1
Name: hbp_archive
Version: 0.9.1
Summary: A high-level API for interacting with the Human Brain Project archival storage at CSCS
Home-page: https://github.com/apdavison/hbp_archive
Author: Andrew P. Davison and Shailesh Appukuttan, CNRS
Author-email: andrew.davison@unic.cnrs-gif.fr
License: UNKNOWN
Description: A high-level API for interacting with the Human Brain Project archival storage at CSCS.
        
        Authors: Andrew Davison and Shailesh Appukuttan, CNRS
        
        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
        ```
        
        <div><img src="https://raw.githubusercontent.com/HumanBrainProject/hbp-validation-client/master/eu_logo.jpg" alt="EU Logo" width="15%" align="right"></div>
        
        ### 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 and No. 785907 (Human Brain Project SGA1 and SGA2).
        
Keywords: swift hbp cscs data
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
