Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.96 KB

README.md

File metadata and controls

53 lines (35 loc) · 1.96 KB

PyUCRio

Github tests PyPI version PyPI Python versions DOI

PyUCRio is a Python library providing data access and analysis support for RF instrument data provided by the University of Calgary. This presently includes the NORSTAR riometers, and the SWAN Hyper Spectral Riometers (HSR).

PyUCRio officially supports Python 3.9+.

Some links to help:

Installation

Installation can be done using pip:

$ pip install pyucrio

For the most bleeding edge version of PyUCRio, you can install it directly from the Github repository:

$ pip install pyucrio@git+https://github.com/ucalgary-srs/pyUCRio

[OR]

$ git clone https://github.com/ucalgary-srs/pyUCRio.git
$ cd pyUCRio
$ pip install .

Usage

Below is how the library can be imported and initialized:

import pyucrio
rio = pyucrio.PyUCRio()

Contributing

Bug reports, feature suggestions, and other contributions are greatly appreciated!

Templates for bug report and feature suggestions can be found when creating a Github Issue. If you have questions or issues installing PyUCRio, we encourage that you open up a topic in the Github Discussions page.

A large collection of examples can be found in the examples directory.