{
    "info": {
        "author": "CHIME/FRB Collaboration",
        "author_email": "charanjot.brar@mcgill.ca",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2.7",
            "Topic :: Software Development :: Build Tools"
        ],
        "description": "# CHIME/FRB Open Data\n\nRead utilties for CHIME/FRB Open Data Release. \n\n## Installation\n```\npip install cfod\n```\nNote: Currently only `Python 2.7` is supported. \n\n## Usage\nTo read a single data file from the data release,\n```python\nfrom cfod import chime_intensity as ci\nfn = `astro_5941664_20180406203904337770_beam0147_00245439_02.msgpack`\nintensity, weights, fpga0, fpgaN, binning, frame0_nano, nrfifreq, rfi_mask = ci.unpack_data(fn)\n```\nwhere:\n  - `intensity` is a 2D Intensity array.\n  - `weights ` are the corresponding 2D array weights to the intensity array.\n  - `fpga0 (int)` is start fpga count of the data chunk. (Internally used to track time, can be ignored). The fpga count increments at the rate of 2.56us.\n  - `fpgaN (int)` is number of fpga counts in the data chunk read\n  - `binning (int)` is the downsampling of the data from the ringbuffer\n  - `frame0_nano` is the conversion from fpga timestamp to utc timestamp (Currently not supported.)\n  - `nrfifreq` is the number of frequences masked by the realtime rfi system (Currently not supported.)\n  - `rfi_mask` is currently not supported\n\nTo read multiple data files at once, you can use the following command,\n```python\nfrom cfod import chime_intensity as ci\nfns = ['file1', 'file2', 'file3']\nintensity, weights, fpga0s, fpgaNs, binning, rfi_mask, frame0_nanos = ci.unpack_datafiles(fns)\n```\n\nTo convert `.msgpack` files into filterbank `.fil` format you can run `msgpack2fil` from the command line. You need to provide a pathname wildcard in quotation marks. To see all command line options run help:  \n```\nmsgpack2fil --help\n```\nCHIME/FRB data has 16384 frequency channels but PRESTO and sigproc by default allocate memory for only a maximum of 4096 channels. You would need to update `reader.h` and `header.h` in sigproc and recompile before trying to read a 16384 filterbank file, or you can let `msgpack2fil` subband data by at least a factor 4 (using the `--fscrunch` argument). Make sure to provide a DM for subband dedispersion (using the `--subdm` argument) to mitigate subband smearing.\n\n## Removal\n```\npip uninstall cfod\n```",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://chime-frb-open-data.github.io/",
        "keywords": "CHIME frb intensity astronomy",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "cfod",
        "package_url": "https://pypi.org/project/cfod/",
        "platform": "",
        "project_url": "https://pypi.org/project/cfod/",
        "project_urls": {
            "Bug Reports": "https://github.com/chime-frb-open-data/chime-frb-open-data/issues",
            "Homepage": "https://chime-frb-open-data.github.io/"
        },
        "release_url": "https://pypi.org/project/cfod/2019.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Python project to read CHIME/FRB Data",
        "version": "2019.2"
    },
    "last_serial": 4765950,
    "releases": {
        "2019.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1f222ee8d04b1ee9c838c81a426192d1",
                    "sha256": "7ccc214e6728763b5434d30653be1468e5dcbb5742d97951249ef7977abe5999"
                },
                "downloads": -1,
                "filename": "cfod-2019.1.tar.gz",
                "has_sig": false,
                "md5_digest": "1f222ee8d04b1ee9c838c81a426192d1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4724,
                "upload_time": "2019-01-22T18:06:04",
                "url": "https://files.pythonhosted.org/packages/a0/14/f54acfb88e02363d1c6ea44e668b5c03a4053764549b3cff4357d854a4d2/cfod-2019.1.tar.gz"
            }
        ],
        "2019.1.post1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "614938132c05770c795441559c4c7319",
                    "sha256": "6444d8997193991c079293a51e89aaab1a1dc6800df9d4f3c570e7f207178502"
                },
                "downloads": -1,
                "filename": "cfod-2019.1.post1.tar.gz",
                "has_sig": false,
                "md5_digest": "614938132c05770c795441559c4c7319",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5283,
                "upload_time": "2019-01-22T18:33:48",
                "url": "https://files.pythonhosted.org/packages/ef/a6/6971c59333d67c87ba81100f5508227abe67bb6935c710e44c98954442ae/cfod-2019.1.post1.tar.gz"
            }
        ],
        "2019.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "24b110dbf147efab227d660b26b8deda",
                    "sha256": "2c1139baadcac9447b93a79738b08fc4efdd53ba760d411d3227232c4ae2d768"
                },
                "downloads": -1,
                "filename": "cfod-2019.2.tar.gz",
                "has_sig": false,
                "md5_digest": "24b110dbf147efab227d660b26b8deda",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10368,
                "upload_time": "2019-01-31T23:30:39",
                "url": "https://files.pythonhosted.org/packages/c9/8c/e5e0b8c6fe33373e664f04ce824078a17b46194f06125cf31fb7ea0c5c93/cfod-2019.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "24b110dbf147efab227d660b26b8deda",
                "sha256": "2c1139baadcac9447b93a79738b08fc4efdd53ba760d411d3227232c4ae2d768"
            },
            "downloads": -1,
            "filename": "cfod-2019.2.tar.gz",
            "has_sig": false,
            "md5_digest": "24b110dbf147efab227d660b26b8deda",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10368,
            "upload_time": "2019-01-31T23:30:39",
            "url": "https://files.pythonhosted.org/packages/c9/8c/e5e0b8c6fe33373e664f04ce824078a17b46194f06125cf31fb7ea0c5c93/cfod-2019.2.tar.gz"
        }
    ]
}