Read functions for NASCAM ASI raw files
Project description
NASCAM All-Sky Imager Raw PGM Data Readfile
Python library for reading NASCAM All-Sky Imager (ASI) stream0 raw PNG-file data. The data can be found at https://data.phys.ucalgary.ca.
Supported Datasets
- NASCAM ASI raw: stream0.png PNG files
Installation
The nascam-imager-readfile library is available on PyPI:
$ python3 -m pip install nascam-imager-readfile
Supported Python Versions
nascam-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 nascam_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 nascam_imager_readfile
>>> filename = "path/to/data/2010/01/01/atha_nascam-iccd04/ut06/20100101_0600_atha_nascam-iccd04.png.tar"
>>> img, meta, problematic_files = nascam_imager_readfile.read(filename)
Read multiple files
>>> import nascam_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2010/01/01/atha_nascam-iccd04/ut06/*.tar")
>>> img, meta, problematic_files = nascam_imager_readfile.read(file_list)
Read using multiple worker processes
>>> import nascam_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2010/01/01/atha_nascam-iccd04/ut06/*.tar")
>>> img, meta, problematic_files = nascam_imager_readfile.read(file_list, workers=4)
Read with no output
>>> import nascam_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2010/01/01/atha_nascam-iccd04/ut06/*.tar")
>>> img, meta, problematic_files = nascam_imager_readfile.read(file_list, workers=4, quiet=True)
Development
Clone the repository and install dependencies using Poetry.
$ git clone https://github.com/ucalgary-aurora/nascam-imager-readfile.git
$ cd nascam-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 nascam_imager_readfile-1.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f2e103e1d1d0c0a0db58180f7034913a2ed749a6af9f5e2b68763bc95228654 |
|
MD5 | f057993bf2536606125a73ee4cdb154b |
|
BLAKE2b-256 | c0433af3d37b4788152c8f0664a8dd12aeed973758f64c081bb10c21d0290600 |
Hashes for nascam_imager_readfile-1.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd1790630196516f9c9939d4cd6c22879dc7a83d6e062e31ec1ece46f6f9c88d |
|
MD5 | 593038cdf7097ab1bd9e9e27f3cc9520 |
|
BLAKE2b-256 | 4b3af39e7caec0f100848b4a8875a40b0889a95b0f842647e2f63184e270fffd |