Skip to main content

NASCAM All-Sky Imager Raw PGM Data Readfile

Github Actions - Tests PyPI version MIT license PyPI Python versions

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

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

Metadata

Release files for nascam-imager-readfile 1.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nascam-imager-readfile 1.4.3
File Size Uploaded Provenance Actions
nascam_imager_readfile-1.4.3.tar.gz 5.9 kB Without provenance Details for nascam_imager_readfile-1.4.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nascam-imager-readfile 1.4.3
File Interpreter ABI Platform Actions
nascam_imager_readfile-1.4.3-py3-none-any.whl Python 3 none any Details for nascam_imager_readfile-1.4.3-py3-none-any.whl

Total release size: 12.2 kB

Release files / nascam_imager_readfile-1.4.3.tar.gz

Download URL nascam_imager_readfile-1.4.3.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
6f2e103e1d1d0c0a0db58180f7034913a2ed749a6af9f5e2b68763bc95228654
BLAKE2b-256 checksum
How to use checksums
c0433af3d37b4788152c8f0664a8dd12aeed973758f64c081bb10c21d0290600
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.11.7 Linux/6.2.0-39-generic

Release files / nascam_imager_readfile-1.4.3-py3-none-any.whl

Download URL nascam_imager_readfile-1.4.3-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fd1790630196516f9c9939d4cd6c22879dc7a83d6e062e31ec1ece46f6f9c88d
BLAKE2b-256 checksum
How to use checksums
4b3af39e7caec0f100848b4a8875a40b0889a95b0f842647e2f63184e270fffd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.11.7 Linux/6.2.0-39-generic

Security for nascam-imager-readfile 1.4.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page