Open Neurophysiology Environment
Project description
Open Neurophysiology Environment
NB: This package is currently in beta
Installing
For Python 3.8 or later, run
pip install ONE-api
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='https://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, password='international') # 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='https://test.alyx.internationalbrainlab.org', make_default=True)
one = ONE() # Connected to https://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 January 2021 onward
eids = one.search(date_range=['2021-01-01',], dataset='wheel.timestamps')
['d3372b15-f696-4279-9be5-98f15783b5bb']
# 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', collection='alf')
# 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-1.2.0.tar.gz
(927.8 kB
view details)
Built Distribution
ONE_api-1.2.0-py3-none-any.whl
(70.9 kB
view details)
File details
Details for the file ONE-api-1.2.0.tar.gz.
File metadata
- Download URL: ONE-api-1.2.0.tar.gz
- Upload date:
- Size: 927.8 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 | 4801581402e6cd323eb25f5534d99887a828b78e65f8493f018dd04c12576c7d |
|
| MD5 | ffc56be7bb3a082a789b405d4544679c |
|
| BLAKE2b-256 | 572f881909a8d66d9ff53a312bd5c350f1c53afa9749602a64871c9124d24379 |
File details
Details for the file ONE_api-1.2.0-py3-none-any.whl.
File metadata
- Download URL: ONE_api-1.2.0-py3-none-any.whl
- Upload date:
- Size: 70.9 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 | 0ea5987f2f60903eecafd78dd5f08fe2cba9b61d98a727dba8d9b7a828ba9056 |
|
| MD5 | 0a19fe8d346c029360f54225b8275d7d |
|
| BLAKE2b-256 | 814ab96ef6b8d9fa1da8e21c3588bf2d8cc1dc21a66bf88a01a77dd3c88f167a |
