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.
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.6+.
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.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f30bf2953d50d7046229a3dce09e804b9bb8933d10e945c89e5f3abe6aa445a6 |
|
MD5 | 77b12a1585c21b2561367c4f39863327 |
|
BLAKE2b-256 | 6a93052234656c0d6a289eb56dafc824fdd708c923f1f2f6f79e8fc8315b06d9 |
Close
Hashes for rego_imager_readfile-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b151dc652dc678065e33128b892072ad37a3c1809b32594b9ba96c4cd7ca0c28 |
|
MD5 | b825396d5357c384024d8d8491af8e05 |
|
BLAKE2b-256 | 93ed37ca1ee2a6eee4d7788bf5c3cbc2b2d72be893be08223ed1f0151cc5521f |