Read functions for Rainbow ASI PNM raw files
Project description
Rainbow All-Sky Imager Raw PGM Data Readfile (GO-Canada AGO/CGSM Rainbow)
Python library for reading Rainbow All-Sky Imager (GO-Canada AGO/CGSM Rainbow) stream0 raw PGM-file data. The data can be found at https://data.phys.ucalgary.ca.
Installation
The rainbow-imager-readfile library is available on PyPI:
$ python3 -m pip install rainbow-imager-readfile
Supported Python Versions
rainbow-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 rainbow_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 rainbow_imager_readfile
>>> filename = "path/to/data/2015/01/01/fsmi_rainbow-11/ut06/20150101_0600_fsmi_rainbow-11_full.pgm.gz"
>>> img, meta, problematic_files = rainbow_imager_readfile.read(filename)
Read multiple files
>>> import rainbow_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2015/01/01/fsmi_rainbow-11/ut06/*full.pgm*")
>>> img, meta, problematic_files = rainbow_imager_readfile.read(file_list)
Read using multiple worker processes
>>> import rainbow_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2015/01/01/fsmi_rainbow-11/ut06/*full.pgm*")
>>> img, meta, problematic_files = rainbow_imager_readfile.read(file_list, workers=4)
Development
Clone the repository and install dependencies using Poetry.
$ git clone https://github.com/ucalgary-aurora/rainbow-imager-readfile.git
$ cd rainbow-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 rainbow_imager_readfile-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7bdfe75840aa5eaa0bf17cccdf94c4df3c106857700c296dc0c9d014293763d |
|
MD5 | 74a0ae9e5ae38252b99e5320e944b578 |
|
BLAKE2b-256 | d9870c071ae16fbb48bd037e18a6146f7b6e74d08f7494a9075df53ed6704030 |
Hashes for rainbow_imager_readfile-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bfe47cbcba0145b0a6bb2fa76651015ad89a18dd1ac590a9a0e775d53dd087d |
|
MD5 | 87c6439afc4daa4daab5d29d9f417102 |
|
BLAKE2b-256 | d495b13ad01e9efe836e6886da93518200370a1995c141a758055e7fa158b97b |