A Python Client for ONCat (the ORNL Neutron Catalog).
Project description
Welcome to PyONCat, a Python client designed to facilitate interaction with the ONCat API.
Introduction
ONCat is a data cataloging system that assists scientists and researchers in managing and navigating their data. It aggregates metadata about data, experiments and users from various systems, offering a convenient and manageable way to access neutron data and associated information.
The pyoncat
package serves as a Python client to more easily interact with the ONCat API.
Installation
Requirements
- Python version:
>=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4
- Python packages:
requests
- Optional packages for authenticated API access:
oauthlib
,requests-oauthlib
Installing with pip
For basic unauthenticated installation, use the following command:
pip install pyoncat
To install the package with support for the authenticated version of the API, use the following command:
pip install pyoncat oauthlib requests-oauthlib
Installing with Conda
A Conda package will be available soon as an alternative installation method.
Usage
Authenticating with the API
To use the authenticated version of the API, you need to obtain credentials from an ONCat administrator. Please contact ONCat Support at oncat-support@ornl.gov to request credentials.
Examples
For usage examples, please refer to the API documentation at oncat.ornl.gov as well as the iPython Notebook tutorial available at this link.
Getting Help
If you encounter any issues or require assistance with the pyoncat
package, please reach out to the ONCat Support at oncat-support@ornl.gov.
Resources
Thank you for using PyONCat!
Project details
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
Built Distribution
Hashes for pyoncat-1.6.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 704ad1873d7b5e9834e8432de66fe3854a699779010d4a020dd64c7a87ee4cb7 |
|
MD5 | 799f8caece7622659ec632a39e4fb5d8 |
|
BLAKE2b-256 | 42b9558e83ddddfc4618eb2a31d3479b0609477f0ebc047c2c173eb3d496cdd0 |