Open Neurophysiology Environment
Project description
Open Neurophysiology Environment
NB: This package is currently in beta
Installing
For development:
pip install git+https://github.com/int-brain-lab/ONE.git@main
For production (not yet ready):
pip install ONE
Set up
For using ONE with a local cache directory:
from one.api import One
one = One(cache_dir='/home/user/downlaods/ONE/behavior_paper')
For setting up ONE for a given database e.g. internal IBL Alyx:
from one.api import ONE
one = ONE(base_url='http://alyx.internationalbrainlab.org')
To use the default setup settings that connect you to the IBL public database:
from one.api import ONE
one = ONE(silent=True) # Will use default information
Once you've setup the server, subsequent calls will use the same parameters:
from one.api import ONE
one = ONE()
To set up ONE for another database and make it the default:
from one.api import OneAlyx, ONE
OneAlyx.setup(client='http://test.alyx.internationalbrainlab.org', make_default=True)
one = ONE() # Connected to http://test.alyx.internationalbrainlab.org
Using ONE
To search for sessions:
from one.api import ONE
one = ONE()
print(one.search_terms) # A list of search keyword arguments
# Search session with wheel timestamps from May onward
eids = one.search(date_range=['2021-05-01',], dataset='wheel.timestamps')
>> ['TODO']
# Search for project sessions with two probes
eids = one.search(data=['probe00', 'probe01'], project='brainwide')
To load data:
from one.api import ONE
one = ONE()
# Load an ALF object
eid = 'a7540211-2c60-40b7-88c6-b081b2213b21'
wheel = one.load_object(eid, 'wheel')
# Load a specific dataset
eid = 'a7540211-2c60-40b7-88c6-b081b2213b21'
ts = one.load_dataset(eid, 'wheel.timestamps')
# Download, but not load, a dataset
filename = one.load_dataset(eid, 'wheel.timestamps', download_only=True)
Further examples and tutorials can be found in examples/
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ONE-api-0.1.0.tar.gz
(86.1 kB
view details)
Built Distribution
ONE_api-0.1.0-py3-none-any.whl
(59.3 kB
view details)
File details
Details for the file ONE-api-0.1.0.tar.gz.
File metadata
- Download URL: ONE-api-0.1.0.tar.gz
- Upload date:
- Size: 86.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3caf5d87b926c9743b39f571389b9a719381093dc098c404ec66a35993dbc210 |
|
| MD5 | 85ae8e99fd80b6e5ff38fbe2c5b2aa14 |
|
| BLAKE2b-256 | 364876a7c704f10356c2b9e2c5ff131e857a94bd3702b23dda6ee86a3f31a7d3 |
File details
Details for the file ONE_api-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ONE_api-0.1.0-py3-none-any.whl
- Upload date:
- Size: 59.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f80991af3c4d3336de92b783d4adcc67910f5dd32d4f05a90290747fb2e352ad |
|
| MD5 | ffae9c17319655d802d440651091cede |
|
| BLAKE2b-256 | a5ee8fef96fa6a5ae778a20995ded33109a9a371d8858bb638ab06300bfa22a8 |
