digital-rf


Namedigital-rf JSON
Version 2.6.8 PyPI version JSON
download
home_pagehttps://github.com/MITHaystack/digital_rf
SummaryPython tools to read/write Digital RF data in HDF5 format
upload_time2022-12-07 19:06:11
maintainer
docs_urlNone
authorMIT Haystack Observatory
requires_python
licenseBSD-3-Clause
keywords hdf5 radio rf
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            The Digital RF project encompasses a standardized HDF5 format for reading and writing of radio frequency data and the software for doing so. The format is designed to be self-documenting for data archive and to allow rapid random access for data processing.

This package includes:

* ``digital_rf`` Python package
* Tools for managing and processing Digital RF data
* ``gr_digital_rf`` Python package for interfacing with GNU Radio
* GNU Radio Companion blocks
* ``thor.py`` UHD radio recorder script
* Example scripts and applications

Digital RF C and MATLAB libraries can be found at the `official source code repository <https://github.com/MITHaystack/digital_rf>`_. To build from source, you must have the HDF5 library and headers installed.

For help and/or questions, contact the `user mailing list <openradar-users@openradar.org>`_.


GNU Radio Configuration
=======================

If you plan on using Digital RF with GNU Radio, make sure to run the `pip` command in the same Python environment that your GNU Radio installation uses so that GNU Radio can find the packages. Depending on your GNU Radio installation, it may be necessary to add the Digital RF blocks to your GRC blocks path by creating or editing the GRC configuration file

:Unix (local): $HOME/.gnuradio/config.conf
:Windows (local): %APPDATA%/.gnuradio/config.conf
:Unix (global): /etc/gnuradio/conf.d/grc.conf
:Custom (global): {INSTALL_PREFIX}/etc/gnuradio/conf.d/grc.conf

to contain::

    [grc]
    local_blocks_path = {PIP_PREFIX}/share/gnuradio/grc/blocks

(replacing ``{PIP_PREFIX}`` with the pip installation prefix, "/usr/local" for example).


Example Usage
=============

The following code will load and read data located in a directory "/data/test".

Load the module and create a reader object::

    import digital_rf as drf
    do = drf.DigitalRFReader('/data/test')

List channels::

    do.get_channels()

Get data bounds for channel 'cha'::

    s, e = do.get_bounds('cha')

Read first 10 samples from channel 'cha'::

    data = do.read_vector(s, 10, 'cha')
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MITHaystack/digital_rf",
    "name": "digital-rf",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "hdf5 radio rf",
    "author": "MIT Haystack Observatory",
    "author_email": "openradar-developers@openradar.org",
    "download_url": "https://files.pythonhosted.org/packages/7e/84/195ad8dafeb1206546cc4e5f56d3fb33c711ac0a072668a566af9e2e09f8/digital_rf-2.6.8.tar.gz",
    "platform": null,
    "description": "The Digital RF project encompasses a standardized HDF5 format for reading and writing of radio frequency data and the software for doing so. The format is designed to be self-documenting for data archive and to allow rapid random access for data processing.\n\nThis package includes:\n\n* ``digital_rf`` Python package\n* Tools for managing and processing Digital RF data\n* ``gr_digital_rf`` Python package for interfacing with GNU Radio\n* GNU Radio Companion blocks\n* ``thor.py`` UHD radio recorder script\n* Example scripts and applications\n\nDigital RF C and MATLAB libraries can be found at the `official source code repository <https://github.com/MITHaystack/digital_rf>`_. To build from source, you must have the HDF5 library and headers installed.\n\nFor help and/or questions, contact the `user mailing list <openradar-users@openradar.org>`_.\n\n\nGNU Radio Configuration\n=======================\n\nIf you plan on using Digital RF with GNU Radio, make sure to run the `pip` command in the same Python environment that your GNU Radio installation uses so that GNU Radio can find the packages. Depending on your GNU Radio installation, it may be necessary to add the Digital RF blocks to your GRC blocks path by creating or editing the GRC configuration file\n\n:Unix (local): $HOME/.gnuradio/config.conf\n:Windows (local): %APPDATA%/.gnuradio/config.conf\n:Unix (global): /etc/gnuradio/conf.d/grc.conf\n:Custom (global): {INSTALL_PREFIX}/etc/gnuradio/conf.d/grc.conf\n\nto contain::\n\n    [grc]\n    local_blocks_path = {PIP_PREFIX}/share/gnuradio/grc/blocks\n\n(replacing ``{PIP_PREFIX}`` with the pip installation prefix, \"/usr/local\" for example).\n\n\nExample Usage\n=============\n\nThe following code will load and read data located in a directory \"/data/test\".\n\nLoad the module and create a reader object::\n\n    import digital_rf as drf\n    do = drf.DigitalRFReader('/data/test')\n\nList channels::\n\n    do.get_channels()\n\nGet data bounds for channel 'cha'::\n\n    s, e = do.get_bounds('cha')\n\nRead first 10 samples from channel 'cha'::\n\n    data = do.read_vector(s, 10, 'cha')",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Python tools to read/write Digital RF data in HDF5 format",
    "version": "2.6.8",
    "split_keywords": [
        "hdf5",
        "radio",
        "rf"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9b504cf9bf3d821e2acdbb0e1eb3e159",
                "sha256": "416ceda7ac8ecfb6cda535bdbca7e21a3c184807406ffac308ff96e3c7e54043"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "9b504cf9bf3d821e2acdbb0e1eb3e159",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": null,
            "size": 2004382,
            "upload_time": "2022-12-07T19:31:17",
            "upload_time_iso_8601": "2022-12-07T19:31:17.670917Z",
            "url": "https://files.pythonhosted.org/packages/3a/9b/fe5a4d95e45ef3491ba242b067f369e4991fbbff09aee032b91502a2e366/digital_rf-2.6.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "460167710692fcbf4bac3abc8cb9b91c",
                "sha256": "288f7ac999bd5b332a5dea0410cb6706ce55bd9409f3c5d5d97e318c056a8bcc"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp37-cp37m-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "460167710692fcbf4bac3abc8cb9b91c",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 1869853,
            "upload_time": "2022-12-07T19:32:18",
            "upload_time_iso_8601": "2022-12-07T19:32:18.124184Z",
            "url": "https://files.pythonhosted.org/packages/76/06/f38cdab0166bafdcabb172c237f3ec3ea8e64a7b990d214f8843218d994f/digital_rf-2.6.8-cp37-cp37m-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e9ba6527dadd4f9420f96f6bcc9b5b34",
                "sha256": "7f99ae9cb7026d73a65e428fa1e15e7b66bf731a9cb8680e7cb3a0c0d8952968"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "e9ba6527dadd4f9420f96f6bcc9b5b34",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 2004359,
            "upload_time": "2022-12-07T19:29:51",
            "upload_time_iso_8601": "2022-12-07T19:29:51.004199Z",
            "url": "https://files.pythonhosted.org/packages/bd/38/c9217df54d02b153680f7aa0b3ef35f21e9a0ef121a25099ffd149b0528b/digital_rf-2.6.8-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2721315c5a0cf50c553f68b1204ec66d",
                "sha256": "db9f9b5cf9c756da18bff00f50ec7577824abe0267ae56f3dc2519e5e3a1a942"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp38-cp38-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "2721315c5a0cf50c553f68b1204ec66d",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 1869912,
            "upload_time": "2022-12-07T19:32:15",
            "upload_time_iso_8601": "2022-12-07T19:32:15.203027Z",
            "url": "https://files.pythonhosted.org/packages/19/87/961b687091e2e589c00aba18c69df0a1f0bd3ac9404c2a834242f1cb601e/digital_rf-2.6.8-cp38-cp38-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "38d354f73c5ca8867f9d29c54513fb93",
                "sha256": "56607fa7e8b9856f12979202e1a537d79dad94b61e5fed588efc61984a83a708"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "38d354f73c5ca8867f9d29c54513fb93",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 2004379,
            "upload_time": "2022-12-07T19:31:20",
            "upload_time_iso_8601": "2022-12-07T19:31:20.133468Z",
            "url": "https://files.pythonhosted.org/packages/66/d1/2de851b2beed5b4ee75d055d61a12eddaf2ee6f1bd0c339e19da7f26d5cd/digital_rf-2.6.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "8b5ece5338cf400c3c5a98931b6d707d",
                "sha256": "4619e579a4559e26919b10b3fe532ad60b80fbe5998e369bbac82f40d5c40103"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp39-cp39-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "8b5ece5338cf400c3c5a98931b6d707d",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": null,
            "size": 1869954,
            "upload_time": "2022-12-07T19:32:30",
            "upload_time_iso_8601": "2022-12-07T19:32:30.620692Z",
            "url": "https://files.pythonhosted.org/packages/7e/fc/c9145fefb6575bf72853119d4708302c5975194e8ba32437b184f99c98b5/digital_rf-2.6.8-cp39-cp39-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "12c70b97e359d95176f2e4451d602bb7",
                "sha256": "94823eccced8dd7156051a0b60672a59f14ae336931c48cf92ced3c6f39aa4d0"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "12c70b97e359d95176f2e4451d602bb7",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": null,
            "size": 2004384,
            "upload_time": "2022-12-07T19:29:42",
            "upload_time_iso_8601": "2022-12-07T19:29:42.812665Z",
            "url": "https://files.pythonhosted.org/packages/64/65/2ac8386771a4483b5b1a33bdc94155df3ed6509f8eacfb69e84b3962c370/digital_rf-2.6.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bf5329d5bd06a4d4308d4bedc99ac386",
                "sha256": "b48f1c0515362d507716194fad5369501e76dd68d6af23814cbf1f68e919bc1f"
            },
            "downloads": -1,
            "filename": "digital_rf-2.6.8.tar.gz",
            "has_sig": true,
            "md5_digest": "bf5329d5bd06a4d4308d4bedc99ac386",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1216468,
            "upload_time": "2022-12-07T19:06:11",
            "upload_time_iso_8601": "2022-12-07T19:06:11.207587Z",
            "url": "https://files.pythonhosted.org/packages/7e/84/195ad8dafeb1206546cc4e5f56d3fb33c711ac0a072668a566af9e2e09f8/digital_rf-2.6.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-07 19:06:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "MITHaystack",
    "github_project": "digital_rf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "lcname": "digital-rf"
}
        
Elapsed time: 0.02509s