{
    "info": {
        "author": "Ben Strutt",
        "author_email": "strutt@physics.ucla.edu",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Operating System :: POSIX",
            "Programming Language :: Python :: 3"
        ],
        "description": "# BeaconTau\n\n## Introduction\n\nA BEACON data analysis package for python3.\n\nThis package uses [pybind11](https://github.com/pybind/pybind11) to get the raw c-structs from [the BEACON c-library](https://github.com/beaconTau/libbeacon) into python.\nThis package calls the c backend to read binary data from disk into your python prompt.\nFrom there all the standard python loveliness is available.\n\n## Quick start\nOnce you've installed the package (see below) define an environment variable called `BEACON_DATA_DIR` with the directory containing all the BEACON runs (and the hk folder).\nFrom your python prompt.\n```python\n>>> import BeaconTau as bt\n>>> dd = bt.DataDirectory()      # Will look in BEACON_DATA_DIR\n>>> r = dd.run(99)               # to get run 99, if you have it\n>>> r.draw('trigger_thresholds')  # *limited* ROOT-style draw functionality is available, emphasis on limited\n>>> e = r.get_entry(0)           # You can access events by entry (index) where 0 is the first event in the run...\n>>> e = r.get_event(99000000002) # or by the full event number (provided it is in the run)\n>>> e.plot()                     # Quickly plot them in the time domain\n>>> e.plot(freq_domain = True)   # Or the frequency domain\n>>> e.channel(3)                 # Gives you the actual waveforms,\n>>> e.channel_psd(3)             # gives you the power spectrum...\n```\nTake a look at the actual source code to see more.\nHappy analyzing!\n\n## Pre-requisites\n1. python3\n   - The recommended way to get it is via miniconda or anaconda if disk space and bandwidth aren't a concern. \n\t - You can find a suite of miniconda installers [here](https://repo.continuum.io/miniconda/).\n   - A recent \"vanilla\" python3 installation should also work fine though.\n\n2. A recent c++ compiler\n   - [pybind11](https://github.com/pybind/pybind11) requires a c++11 compiler (clue is in the name).\n   - Unless you're on a very old machine you probably don't need to worry about this, otherwise install more recent c++ compiler and check it is invoked by default.\n\n## Installation\n\nHere are two installation methods.\nThe only significant difference between them is that one requires you to choose (and need to remember) where you put your python environment.\nFor that reason I'm recommending the first of the two, installing via conda (then pip).\n\n### 1. From PyPI with anaconda (or miniconda) *Recommended*\nMake sure you have an anaconda3 or miniconda3 installation.\nYou can get a miniconda installation for you architecture [here](https://repo.continuum.io/miniconda/).\n\nFirst create an environment for your BeaconTau to live in, for the sake of these instructions I'm calling it Beacon.\n\n```bash\nconda create Beacon\n```\n\nThen make sure you have pip installed (you may as well let it upgrade itself to the latest and greatest version)\n```bash\nconda install pip\npip install --upgrade pip\n```\n\nFinally, install BeaconTau (sadly the name Beacon was already taken)\n```bash\npip  install BeaconTau\n```\n\nThen, fire up python and you're good to go.\n```python\n>>> import BeaconTau\n```\n\nNote that for future sessions you will need to do `conda activate Beacon` before starting python to have access to all the BeaconTau goodies.\n\n\n### 2. From PyPI without anaconda (in a virtualenv)\nSimilar-ish to the adaconda method.\nFirst, navigate to the directory you want to do some BEACON analysis in.\nThen create a virtual environment, for the sake of these instructions I'm calling BeaconEnv.\n\n```bash\npython3 -m venv BeaconTau-env # Creates a virtual environment (you need only do this once)\nsource BeaconTau-env/bin/activate # Load the virtual environment (do this once per terminal session)\npip install BeaconTau # Install from PyPI (only need to do this once, unless upgrading)\n```\nFrom there start `python`\n\n```python\n>>> import BeaconTau\n```\nAnd you should be good to go.\nRemember that you will need to do `source BeaconTau-env/bin/activate` each time you want to use this python module!\n\n\n## Version history\n\nSee [RELEASES.md](https://github.com/beaconTau/BeaconTau/blob/master/RELEASES.md).",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/beaconTau/BeaconTau",
        "keywords": "",
        "license": "GPL3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "BeaconTau",
        "package_url": "https://pypi.org/project/BeaconTau/",
        "platform": "",
        "project_url": "https://pypi.org/project/BeaconTau/",
        "project_urls": {
            "Homepage": "https://github.com/beaconTau/BeaconTau"
        },
        "release_url": "https://pypi.org/project/BeaconTau/0.1.6/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A package for interacting with BEACON data in python",
        "version": "0.1.6"
    },
    "last_serial": 4594819,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "29d6c46d8e24b29c471a422521b8f530",
                    "sha256": "199c1a55c1d5d09b64a48eddb8a64979980003e7886159f7497b00c77f199245"
                },
                "downloads": -1,
                "filename": "BeaconTau-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "29d6c46d8e24b29c471a422521b8f530",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6662,
                "upload_time": "2018-09-04T14:35:25",
                "url": "https://files.pythonhosted.org/packages/d2/b8/b9fd701f577fefc1d7739804f1ebb237830591d206f46894e5f6d04f6245/BeaconTau-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4c0d87ac370f2ed38fe6c78236502b72",
                    "sha256": "650720a5fd668b1b7b1bf22662e8583eb237b3cd0f6e477a88167edc5162b5a4"
                },
                "downloads": -1,
                "filename": "BeaconTau-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "4c0d87ac370f2ed38fe6c78236502b72",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7437,
                "upload_time": "2018-09-04T15:30:17",
                "url": "https://files.pythonhosted.org/packages/30/9a/b265845399c211ced7029f1b00407438b637d7d188533e60fc3a1a270917/BeaconTau-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "dac15b0c9d7b860e4f49f85a71b1ac39",
                    "sha256": "37cf3cbd245a7aca2a5df5c0cfec0bd2f58a8b36af8f5792d2cd7487df01739a"
                },
                "downloads": -1,
                "filename": "BeaconTau-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "dac15b0c9d7b860e4f49f85a71b1ac39",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7460,
                "upload_time": "2018-09-04T15:42:29",
                "url": "https://files.pythonhosted.org/packages/90/0f/eafaddb06b85d1ce0b16623eef0dd96148dc7ac8c59c5198fc9f8bbaaf1a/BeaconTau-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0454fc632fdeae49029bc418a2dcd861",
                    "sha256": "af84f9aabfd339c9d300492b15cf09d785557ac824530cd2a1830fbba6009652"
                },
                "downloads": -1,
                "filename": "BeaconTau-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "0454fc632fdeae49029bc418a2dcd861",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10328,
                "upload_time": "2018-09-07T10:53:09",
                "url": "https://files.pythonhosted.org/packages/f9/6b/fa57393795e679ac94c8cc3c3ce6256ee60d6ed48dfab32ba8721b29442e/BeaconTau-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fbbbb7912cd2fdedff4e784012fa0fb4",
                    "sha256": "76cfd21c711b1ee5dc42453dde6c35b25696ae77b6719f060053fe9311dd6022"
                },
                "downloads": -1,
                "filename": "BeaconTau-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "fbbbb7912cd2fdedff4e784012fa0fb4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10941,
                "upload_time": "2018-09-26T13:28:59",
                "url": "https://files.pythonhosted.org/packages/9e/1a/ecb92eb6c7622e7ef535e4a5aefd760f15df349a6403da551778be3c4485/BeaconTau-0.1.5.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b9753118fb59fb6c900e32e7a272496f",
                    "sha256": "16a09a07438967daead23905400f32d1a8f35385d4e2e7112f2ade13ac8f7847"
                },
                "downloads": -1,
                "filename": "BeaconTau-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "b9753118fb59fb6c900e32e7a272496f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14734,
                "upload_time": "2018-12-13T15:41:31",
                "url": "https://files.pythonhosted.org/packages/13/f6/84276a875c265fa8b47e0a809e9dade7109663b66d9aa71137250f72eba7/BeaconTau-0.1.6.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b9753118fb59fb6c900e32e7a272496f",
                "sha256": "16a09a07438967daead23905400f32d1a8f35385d4e2e7112f2ade13ac8f7847"
            },
            "downloads": -1,
            "filename": "BeaconTau-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "b9753118fb59fb6c900e32e7a272496f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14734,
            "upload_time": "2018-12-13T15:41:31",
            "url": "https://files.pythonhosted.org/packages/13/f6/84276a875c265fa8b47e0a809e9dade7109663b66d9aa71137250f72eba7/BeaconTau-0.1.6.tar.gz"
        }
    ]
}