Read functions for THEMIS ASI PGM raw files
Project description
THEMIS All-Sky Imager Raw PGM Data Readfile
Python library for reading THEMIS All-Sky Imager (ASI) stream0 raw PGM-file data. The data can be found at https://data.phys.ucalgary.ca or http://themis.igpp.ucla.edu/index.shtml.
Supported Datasets
- THEMIS ASI raw: stream0 PGM files
Installation
The themis-imager-readfile library is available on PyPI:
$ python3 -m pip install themis-imager-readfile
Supported Python Versions
themis-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 themis_imager_readfile
Read a single file
>>> import themis_imager_readfile
>>> filename = "path/to/data/2020/01/01/atha_themis02/ut06/20200101_0600_atha_themis02_full.pgm.gz"
>>> img, meta, problematic_files = themis_imager_readfile.read(filename)
Read multiple files
>>> import themis_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2020/01/01/atha_themis02/ut06/*full.pgm*")
>>> img, meta, problematic_files = themis_imager_readfile.read(file_list)
Read using multiple worker processes
>>> import themis_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2020/01/01/atha_themis02/ut06/*full.pgm*")
>>> img, meta, problematic_files = themis_imager_readfile.read(file_list, workers=4)
Development
Clone the repository and install dependencies using Poetry.
$ git clone https://github.com/ucalgary-aurora/themis-imager-readfile.git
$ cd themis-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 themis-imager-readfile-1.0.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86a6e6dad89e4b42ae62e61e8b1d719afa837a3c9e3fd33cdeb0841bc394ccc5 |
|
MD5 | 54b1398bcb4e454fa3bc811206234ac6 |
|
BLAKE2b-256 | 3ec89896c9aa22876e299079a5b59e6796b0cf62960fcc9f0dbfcb7578fd37ac |
Close
Hashes for themis_imager_readfile-1.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9ae99cbbdc4931eff70b279e780c214a272fcac9fe03cd28028b92035ea5754 |
|
MD5 | e76421e34fa5fd9834c4f9be64c37d18 |
|
BLAKE2b-256 | abb451ad1d9e14fa70c872483b82c5d0594bd643c3c4a74262c439b7312a8d7a |