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
Warning: On Windows, be sure to put any read
calls into a main()
method. This is because we utilize the multiprocessing library and the method of forking processes in Windows requires it. Note that if you're using Jupyter or other IPython-based interfaces, this is not required.
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
Hashes for rego_imager_readfile-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a3adcdbb8e17aaec19d522dbf36b6efc910d50ff2b3ddf142e784e5c07c3445 |
|
MD5 | bb06820389d86bd55fe6a9b60dee7fe6 |
|
BLAKE2b-256 | 134ce3ea9c62cae61933b3f7c24677e4f4edd11b8d4c95525318039ef281af06 |
Hashes for rego_imager_readfile-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 167ba5bf6a601e13385886a4957bbdd008438c03b3a940376b966e33376f2d51 |
|
MD5 | 184a2390ec420c2cba59590a5f1f593b |
|
BLAKE2b-256 | a4733f5812c2791bb7d308af719309540a7ecde715bd725e0bb2a4653efe370f |