Read functions for REGO ASI PGM raw files
Project description
Redline All-Sky Imager Raw PGM Data Readfile (REGO)
Python library for reading REGO All-Sky Imager (ASI) stream0 raw PGM-file data. The data can be found at https://data.phys.ucalgary.ca.
Supported Datasets
- REGO raw: stream0 PGM files
Installation
The rego-imager-readfile library is available on PyPI:
$ python3 -m pip install rego-imager-readfile
Supported Python Versions
rego-imager-readfile officially supports Python 3.8+.
Examples
Example Python notebooks can be found in the "examples" directory. Further, some examples can be found in the "Usage" section below.
Usage
Import the library using import rego_imager_readfile
Read a single file
>>> import rego_imager_readfile
>>> filename = "path/to/data/2020/01/01/fsmi_rego-654/ut06/20200101_0600_fsmi_rego-654_6300.pgm.gz"
>>> img, meta, problematic_files = rego_imager_readfile.read(filename)
Read multiple files
>>> import rego_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2020/01/01/fsmi_rego-654/ut06/*6300.pgm*")
>>> img, meta, problematic_files = rego_imager_readfile.read(file_list)
Read using multiple worker processes
>>> import rego_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2020/01/01/fsmi_rego-654/ut06/*6300.pgm*")
>>> img, meta, problematic_files = rego_imager_readfile.read(file_list, workers=4)
Development
Clone the repository and install dependencies using Poetry.
$ git clone https://github.com/ucalgary-aurora/rego-imager-readfile.git
$ cd rego-imager-readfile/python
$ make install
Testing
$ make test
[ or do each test separately ]
$ make test-flake8
$ make test-pylint
$ make test-pytest
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
Close
Hashes for rego_imager_readfile-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1d1c89fc6a0e14278015f9ce7b9142505bc1e01bd38b3b71a553033591f7c45 |
|
MD5 | 5b30f16cf83716736ed3d43cfd80c334 |
|
BLAKE2b-256 | 95bd393e7a8f0cd1ff7bd18359e4443c81267e5a5807fddd463a84f765a8f249 |
Close
Hashes for rego_imager_readfile-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 553c893faa686e7f0253c6123e960a0701300be0647fbf724a144620658caede |
|
MD5 | 0348e255c1b9b4e5763c3add66e4c6c9 |
|
BLAKE2b-256 | 5e6ac41070565740482e7954122d74504a91dc26ba90a123684744f70d7ae629 |