decode


Namedecode JSON
Version 2024.9.1 PyPI version JSON
download
home_pagehttps://github.com/deshima-dev/decode/
SummaryDESHIMA code for data analysis
upload_time2024-09-04 11:25:48
maintainerNone
docs_urlNone
authorAkio Taniguchi
requires_python<3.13,>=3.9
licenseMIT
keywords astronomy data-analysis deshima spectroscopy submillimeter
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # de:code

[![Release](https://img.shields.io/pypi/v/decode?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/decode/)
[![Python](https://img.shields.io/pypi/pyversions/decode?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/decode/)
[![Downloads](https://img.shields.io/pypi/dm/decode?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/decode)
[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.3384216-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.3384216)
[![Tests](https://img.shields.io/github/actions/workflow/status/deshima-dev/decode/tests.yaml?label=Tests&style=flat-square)](https://github.com/deshima-dev/decode/actions)

DESHIMA code for data analysis

## Installation

```shell
pip install decode==2024.9.1
```

## Quick look

de:code ships with a quick look command `decode-qlook`, which will be available from the CUI after installation. It has several subcommands for each observation type. For example, to quick-look at a raster observation:
```shell
$ decode-qlook raster /path/to/dems.zarr.zip
```
where `dems.zarr.zip` is the merged observation data ([DESHIMA measurement set: DEMS](https://github.com/deshima-dev/dems)) to be checked. By default, it will output an image of the result plots by a simple analysis (e.g. continuum map, etc). You can also get the result data themselves by changing the output format:
```shell
$ decode-qlook raster /path/to/dems.zarr.zip --format zarr.zip
```
See the command help for all available options:
```shell
# list of the subcommands and descriptions
$ decode-qlook --help

# list of the available command options
$ decode-qlook raster --help
```

If you are not sure about the observation type, the `auto` subcommand may be useful to automatically select the appropriate command to use:
```shell
$ decode-qlook auto /path/to/dems.zarr.zip
```

Finally, all subcommands are available as functions in the `qlook` submodule. For example, the `raster` command corresponds to `decode.qlook.raster` and the following Python code is equivalent to the CUI:
```python
import decode

decode.qlook.raster("/path/to/dems.zarr.zip")
```
See [the qlook module documentation](https://deshima-dev.github.io/decode/_apidoc/decode.qlook.html) for more information.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/deshima-dev/decode/",
    "name": "decode",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.9",
    "maintainer_email": null,
    "keywords": "astronomy, data-analysis, deshima, spectroscopy, submillimeter",
    "author": "Akio Taniguchi",
    "author_email": "taniguchi@a.phys.nagoya-u.ac.jp",
    "download_url": "https://files.pythonhosted.org/packages/f7/ee/5420650c57124a8793f5194a32abfeb1c44f82736741b884815c83af1cee/decode-2024.9.1.tar.gz",
    "platform": null,
    "description": "# de:code\n\n[![Release](https://img.shields.io/pypi/v/decode?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/decode/)\n[![Python](https://img.shields.io/pypi/pyversions/decode?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/decode/)\n[![Downloads](https://img.shields.io/pypi/dm/decode?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/decode)\n[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.3384216-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.3384216)\n[![Tests](https://img.shields.io/github/actions/workflow/status/deshima-dev/decode/tests.yaml?label=Tests&style=flat-square)](https://github.com/deshima-dev/decode/actions)\n\nDESHIMA code for data analysis\n\n## Installation\n\n```shell\npip install decode==2024.9.1\n```\n\n## Quick look\n\nde:code ships with a quick look command `decode-qlook`, which will be available from the CUI after installation. It has several subcommands for each observation type. For example, to quick-look at a raster observation:\n```shell\n$ decode-qlook raster /path/to/dems.zarr.zip\n```\nwhere `dems.zarr.zip` is the merged observation data ([DESHIMA measurement set: DEMS](https://github.com/deshima-dev/dems)) to be checked. By default, it will output an image of the result plots by a simple analysis (e.g. continuum map, etc). You can also get the result data themselves by changing the output format:\n```shell\n$ decode-qlook raster /path/to/dems.zarr.zip --format zarr.zip\n```\nSee the command help for all available options:\n```shell\n# list of the subcommands and descriptions\n$ decode-qlook --help\n\n# list of the available command options\n$ decode-qlook raster --help\n```\n\nIf you are not sure about the observation type, the `auto` subcommand may be useful to automatically select the appropriate command to use:\n```shell\n$ decode-qlook auto /path/to/dems.zarr.zip\n```\n\nFinally, all subcommands are available as functions in the `qlook` submodule. For example, the `raster` command corresponds to `decode.qlook.raster` and the following Python code is equivalent to the CUI:\n```python\nimport decode\n\ndecode.qlook.raster(\"/path/to/dems.zarr.zip\")\n```\nSee [the qlook module documentation](https://deshima-dev.github.io/decode/_apidoc/decode.qlook.html) for more information.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "DESHIMA code for data analysis",
    "version": "2024.9.1",
    "project_urls": {
        "Documentation": "https://deshima-dev.github.io/decode/",
        "Homepage": "https://github.com/deshima-dev/decode/"
    },
    "split_keywords": [
        "astronomy",
        " data-analysis",
        " deshima",
        " spectroscopy",
        " submillimeter"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fcc4a90165471180adcc01beb1035724682cfd6975329de0834898664709995d",
                "md5": "6902323ce2f2bfd283513efa8b2d99f2",
                "sha256": "2c73f213380a0a8717d7b57899cc0855161ad3a01f817d361dcf4a29231a1dbb"
            },
            "downloads": -1,
            "filename": "decode-2024.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6902323ce2f2bfd283513efa8b2d99f2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.9",
            "size": 307895,
            "upload_time": "2024-09-04T11:25:46",
            "upload_time_iso_8601": "2024-09-04T11:25:46.512108Z",
            "url": "https://files.pythonhosted.org/packages/fc/c4/a90165471180adcc01beb1035724682cfd6975329de0834898664709995d/decode-2024.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7ee5420650c57124a8793f5194a32abfeb1c44f82736741b884815c83af1cee",
                "md5": "630bac6d966856759b58d34213fde9db",
                "sha256": "39478a2a0e47945f9bc14294b72620955cdf1ebf1acaa07a3227870b510fe897"
            },
            "downloads": -1,
            "filename": "decode-2024.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "630bac6d966856759b58d34213fde9db",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.9",
            "size": 303884,
            "upload_time": "2024-09-04T11:25:48",
            "upload_time_iso_8601": "2024-09-04T11:25:48.590784Z",
            "url": "https://files.pythonhosted.org/packages/f7/ee/5420650c57124a8793f5194a32abfeb1c44f82736741b884815c83af1cee/decode-2024.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-04 11:25:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "deshima-dev",
    "github_project": "decode",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "decode"
}
        
Elapsed time: 0.46585s