nascam-imager-readfile


Namenascam-imager-readfile JSON
Version 1.4.3 PyPI version JSON
download
home_pagehttps://github.com/ucalgary-aurora/nascam-imager-readfile
SummaryRead functions for NASCAM ASI raw files
upload_time2024-02-05 22:26:14
maintainer
docs_urlNone
authorDarren Chaddock
requires_python>=3.8.1,<4.0.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # NASCAM All-Sky Imager Raw PGM Data Readfile

[![Github Actions - Tests](https://github.com/ucalgary-aurora/nascam-imager-readfile/workflows/tests/badge.svg)](https://github.com/ucalgary-aurora/nascam-imager-readfile/actions?query=workflow%3Atests)
[![PyPI version](https://img.shields.io/pypi/v/nascam-imager-readfile.svg)](https://pypi.python.org/pypi/nascam-imager-readfile/)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/ucalgary-aurora/nascam-imager-readfile/blob/main/LICENSE)
[![PyPI Python versions](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue)](https://pypi.python.org/pypi/nascam-imager-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](https://data.phys.ucalgary.ca/sort_by_project/NORSTAR/nascam-msi/stream0.png) PNG files

## Installation

The nascam-imager-readfile library is available on PyPI:

```console
$ 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

```python
>>> 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

```python
>>> 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

```python
>>> 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

```python
>>> 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.

```console
$ git clone https://github.com/ucalgary-aurora/nascam-imager-readfile.git
$ cd nascam-imager-readfile/python
$ make install
```

## Testing

```console
$ make test
[ or do each test separately ]
$ make test-flake8
$ make test-pylint
$ make test-pytest
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ucalgary-aurora/nascam-imager-readfile",
    "name": "nascam-imager-readfile",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.1,<4.0.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Darren Chaddock",
    "author_email": "dchaddoc@ucalgary.ca",
    "download_url": "https://files.pythonhosted.org/packages/c0/43/3af3d37b4788152c8f0664a8dd12aeed973758f64c081bb10c21d0290600/nascam_imager_readfile-1.4.3.tar.gz",
    "platform": null,
    "description": "# NASCAM All-Sky Imager Raw PGM Data Readfile\n\n[![Github Actions - Tests](https://github.com/ucalgary-aurora/nascam-imager-readfile/workflows/tests/badge.svg)](https://github.com/ucalgary-aurora/nascam-imager-readfile/actions?query=workflow%3Atests)\n[![PyPI version](https://img.shields.io/pypi/v/nascam-imager-readfile.svg)](https://pypi.python.org/pypi/nascam-imager-readfile/)\n[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/ucalgary-aurora/nascam-imager-readfile/blob/main/LICENSE)\n[![PyPI Python versions](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue)](https://pypi.python.org/pypi/nascam-imager-readfile/)\n\nPython library for reading NASCAM All-Sky Imager (ASI) stream0 raw PNG-file data. The data can be found at https://data.phys.ucalgary.ca.\n\n## Supported Datasets\n\n- NASCAM ASI raw: [stream0.png](https://data.phys.ucalgary.ca/sort_by_project/NORSTAR/nascam-msi/stream0.png) PNG files\n\n## Installation\n\nThe nascam-imager-readfile library is available on PyPI:\n\n```console\n$ python3 -m pip install nascam-imager-readfile\n```\n\n## Supported Python Versions\n\nnascam-imager-readfile officially supports Python 3.8+.\n\n## Examples\n\nExample Python notebooks can be found in the \"examples\" directory. Further, some examples can be found in the \"Usage\" section below.\n\n## Usage\n\nImport the library using `import nascam_imager_readfile`\n\n**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.\n\n### Read a single file\n\n```python\n>>> import nascam_imager_readfile\n>>> filename = \"path/to/data/2010/01/01/atha_nascam-iccd04/ut06/20100101_0600_atha_nascam-iccd04.png.tar\"\n>>> img, meta, problematic_files = nascam_imager_readfile.read(filename)\n```\n\n### Read multiple files\n\n```python\n>>> import nascam_imager_readfile, glob\n>>> file_list = glob.glob(\"path/to/files/2010/01/01/atha_nascam-iccd04/ut06/*.tar\")\n>>> img, meta, problematic_files = nascam_imager_readfile.read(file_list)\n```\n\n### Read using multiple worker processes\n\n```python\n>>> import nascam_imager_readfile, glob\n>>> file_list = glob.glob(\"path/to/files/2010/01/01/atha_nascam-iccd04/ut06/*.tar\")\n>>> img, meta, problematic_files = nascam_imager_readfile.read(file_list, workers=4)\n```\n\n### Read with no output\n\n```python\n>>> import nascam_imager_readfile, glob\n>>> file_list = glob.glob(\"path/to/files/2010/01/01/atha_nascam-iccd04/ut06/*.tar\")\n>>> img, meta, problematic_files = nascam_imager_readfile.read(file_list, workers=4, quiet=True)\n```\n\n## Development\n\nClone the repository and install dependencies using Poetry.\n\n```console\n$ git clone https://github.com/ucalgary-aurora/nascam-imager-readfile.git\n$ cd nascam-imager-readfile/python\n$ make install\n```\n\n## Testing\n\n```console\n$ make test\n[ or do each test separately ]\n$ make test-flake8\n$ make test-pylint\n$ make test-pytest\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Read functions for NASCAM ASI raw files",
    "version": "1.4.3",
    "project_urls": {
        "Homepage": "https://github.com/ucalgary-aurora/nascam-imager-readfile",
        "Repository": "https://github.com/ucalgary-aurora/nascam-imager-readfile"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4b3af39e7caec0f100848b4a8875a40b0889a95b0f842647e2f63184e270fffd",
                "md5": "593038cdf7097ab1bd9e9e27f3cc9520",
                "sha256": "fd1790630196516f9c9939d4cd6c22879dc7a83d6e062e31ec1ece46f6f9c88d"
            },
            "downloads": -1,
            "filename": "nascam_imager_readfile-1.4.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "593038cdf7097ab1bd9e9e27f3cc9520",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1,<4.0.0",
            "size": 6315,
            "upload_time": "2024-02-05T22:26:13",
            "upload_time_iso_8601": "2024-02-05T22:26:13.741890Z",
            "url": "https://files.pythonhosted.org/packages/4b/3a/f39e7caec0f100848b4a8875a40b0889a95b0f842647e2f63184e270fffd/nascam_imager_readfile-1.4.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c0433af3d37b4788152c8f0664a8dd12aeed973758f64c081bb10c21d0290600",
                "md5": "f057993bf2536606125a73ee4cdb154b",
                "sha256": "6f2e103e1d1d0c0a0db58180f7034913a2ed749a6af9f5e2b68763bc95228654"
            },
            "downloads": -1,
            "filename": "nascam_imager_readfile-1.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f057993bf2536606125a73ee4cdb154b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1,<4.0.0",
            "size": 5866,
            "upload_time": "2024-02-05T22:26:14",
            "upload_time_iso_8601": "2024-02-05T22:26:14.808308Z",
            "url": "https://files.pythonhosted.org/packages/c0/43/3af3d37b4788152c8f0664a8dd12aeed973758f64c081bb10c21d0290600/nascam_imager_readfile-1.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 22:26:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ucalgary-aurora",
    "github_project": "nascam-imager-readfile",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nascam-imager-readfile"
}
Darren Chaddock
Elapsed time: 0.32688s