{
    "info": {
        "author": "Laura Domine, Ji Won Park, Kazuhiro Terao",
        "author_email": "temigo@gmx.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2.7",
            "Topic :: Scientific/Engineering :: Artificial Intelligence",
            "Topic :: Scientific/Engineering :: Image Recognition",
            "Topic :: Scientific/Engineering :: Physics"
        ],
        "description": "# faster-particles: Pixel Proposal Network (PPN) for particles images and related tools\n\n## Introduction\nThis package includes the following:\n* Toydata generator\n* LArCV data interface (2D and 3D)\n* Base network: VGG(ish) and UResNet\n* Pixel Proposal Network implementation\n\n## Contents\n1. [Installation](#Installation)\n  1.1. [Dependencies](#Dependencies)\n  1.2. [Install](#Install)\n2. [Usage](#Usage)\n  2.1. [Dataset](#Dataset)\n\n## License\nThis code is released under the MIT License (refer to the LICENSE file for more details).\n\n\n## Installation\n### Dependencies\nYou must install [larcv2](https://github.com/DeepLearnPhysics/larcv2) and its\nown dependencies (ROOT, OpenCV, Numpy) in order to use LArCV data interface.\nTo install `larcv2`:\n```bash\ngit clone https://github.com/DeepLearnPhysics/larcv2.git\ncd larcv2\nsource configure.sh\nmake\n```\nYou will also need [Tensorflow](http://tensorflow.org/).\n\n### Install\nThe easiest way is to use Pip, although you will not get the latest changes:\n```bash\npip install faster-particles\n```\n\nAlternatively, you can also clone the source if you want the latest updates or\nparticipate to its development:\n```bash\ngit clone https://github.com/Temigo/faster-particles.git\ncd faster-particles\n```\n\n## Usage\n\n**The following assumes you installed with pip. If you cloned the source, make\nsure you are in the root directory and replace `ppn` with `python faster_particles/bin/ppn.py`.**\n\n### Dataset\n**Toydata**\nTo use toydata rather than LArCV data in the following sections, use the option `--toydata`.\n*This is an old option which has not been tested for a while and which should be deprecated soon.*\n\n**Liquid Argon data files**\nLArCV data files should be specified with `--data` option which supports regex, e.g. `ppn_p[01]*.root`.\nSome data files are publicly available at [DeepLearnPhysics](http://deeplearnphysics.org/DataChallenge/) data challenge page.\n\nThe generic usage is `ppn train/demo [directories options] [network architecture] [weights options] [network options] [other options]`. `train` is for training networks, `demo` is for running inference.\n\n### Directories options\nThe program output is divided between:\n* Output directory (option `-o`): with all the weights\n* Log directory (option `-l`): to store all Tensorflow logs (and visualize them with Tensorboard)\n* Display directory (option `-d`): stores regular snapshots taken during training of PPN1 and PPN2 proposals compared to ground truth.\nThe directories will be created if they do not exist yet. At training time all of them are required. At inference time only the display directory is required.\n\n### Network architectures and weights options\n#### Training\n| Network trained | Command to run | Pretrained weights (optional) |\n| --------------- | -------------------- | -------|\n| Base network UResNet    | `--base-net uresnet --net base | `-wb uresnet.ckpt` |\n| Base network VGG        | `--base-net vgg --net base` | `-wb vgg.ckpt` |\n| PPN (w/ UResNet base)   | `--base-net uresnet --net ppn` | `-wp ppn.ckpt` |\n| Small UResNet           | `--base-net uresnet --net small_uresnet` | `-ws small_uresnet.ckpt` |\n\n### Inference\nUse the command `ppn demo -d display/dir -m N_inferences` followed by:\n\n| Network | Commandline options | Weights loading |\n| --------|---------------------|-----------------|\n| Base (UResNet)        | `--base-net uresnet --net base` | `--wb uresnet.ckpt` |\n| PPN (w/ UResNet base) | `--base-net uresnet --net ppn`  | `--wp ppn.ckpt` |\n| Small UResNet         | `--base-net uresnet --net small_uresnet` | `--ws model.ckpt` |\n| PPN + UResNet         | `--base-net uresnet --net full` | `--wb uresnet.ckpt --wp ppn.ckpt` |\n| PPN + Small UResNet   | `--base-net uresnet --net ppn_ext` | `--wp ppn.ckpt --ws small_uresnet.ckpt` |\n\n### Most common options\n|Option|Explanation|\n|-----|----|\n|`-m`| Number of steps / images to run on |\n|`--freeze` | Freeze base network layers during training. |\n|`-N` | Size of the image |\n|`-3d`| 3D version |\n|`-data`| Path to data files, can use wildcards and bash syntax. |\n\nMore options such as thresholds are available through `ppn train -h` and `ppn demo -h` respectively.\n\n### Examples\nTo train PPN on 1000 steps use:\n```bash\nppn train -o output/dir/ -l log/dir/ -d display/dir --net ppn -m 1000 --data path/to/data\n```\n\nTo train the base network (currently VGG and UResNet available) on track/shower classification task use:\n```bash\nppn train -o output/dir/ -l log/dir/ -d display/dir --net base --base-net vgg -m 1000\n```\n\nTo train on 3D data, use the argument `-3d` and don't forget to specify the image size with `-N` argument (e.g. 192 for a compression factor of 4, see `larcvdata_generator.py` for more details).\n\nTo train PPN with UResNet base network pretrained weights, while freezing the base (pre-trained) layers,\n a more complete command line would be\n```\nppn train -o output/dir/ -l log/dir/ -d display/dir --net ppn --base-net uresnet -wb /path/to/uresnet/weights --freeze -N 512 -m 100\n```\n\nTo run inference with a minimal score of 0.5 for predicted points:\n```bash\nppn demo weights_file.ckpt -d display/dir/ -ms 0.5\n```\nThe display directory will contain snapshots of the results.\n\n\n## Authors\nK.Terao, J.W. Park, L.Domine",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Temigo/faster-particles",
        "keywords": "physics",
        "license": "LICENSE.md",
        "maintainer": "",
        "maintainer_email": "",
        "name": "faster-particles",
        "package_url": "https://pypi.org/project/faster-particles/",
        "platform": "",
        "project_url": "https://pypi.org/project/faster-particles/",
        "project_urls": {
            "Bug Reports": "https://github.com/Temigo/faster-particles/issues",
            "Homepage": "https://github.com/Temigo/faster-particles",
            "Source": "https://github.com/Temigo/faster-particles"
        },
        "release_url": "https://pypi.org/project/faster-particles/0.3.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Point Proposal Network for particles images and related tools.",
        "version": "0.3.0"
    },
    "last_serial": 4133006,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "84b0f34d97c3a7ca9800fe17857453f1",
                    "sha256": "ce27d9d59dca04a2d748f015c1424ba7e5caf128275c548588ab66e659e093ff"
                },
                "downloads": -1,
                "filename": "faster_particles-0.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "84b0f34d97c3a7ca9800fe17857453f1",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 33077,
                "upload_time": "2018-03-30T22:44:53",
                "url": "https://files.pythonhosted.org/packages/5b/c9/6b35effbbd3dfdde8bf5dea8b4c2327a8051d72224e62beb60f029e31a3c/faster_particles-0.1.1-py2.py3-none-any.whl"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "79d735bdacc36e084ffefcbdb49112bb",
                    "sha256": "54bf79e4261e8162819d5653e9350273d20c06b9bdde72a0d5a3682c53007d77"
                },
                "downloads": -1,
                "filename": "faster_particles-0.1.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "79d735bdacc36e084ffefcbdb49112bb",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 33344,
                "upload_time": "2018-03-30T22:57:29",
                "url": "https://files.pythonhosted.org/packages/72/b1/6daf3e3f2e21a19e0b5a2d7d5161cfea6167d9a0527c0461c945df2cb964/faster_particles-0.1.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c6289f7b554ba7a19e74a29a20741eb5",
                    "sha256": "5513e871d3da51d9b948acbf6cb9035c70d69e66417eddf6fb94524319c63e93"
                },
                "downloads": -1,
                "filename": "faster-particles-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "c6289f7b554ba7a19e74a29a20741eb5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 26715,
                "upload_time": "2018-03-30T22:57:13",
                "url": "https://files.pythonhosted.org/packages/f8/5c/52e56f31e19dd0af4406878d457bcd1c29260b831d43e70478d9b06f46f3/faster-particles-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "dd2dea3708dcb601037faee15c5ea678",
                    "sha256": "47b9d77b6ebe5cf8387c7865998d34cf3152d65ec3b0ddad5720e749af331c3c"
                },
                "downloads": -1,
                "filename": "faster_particles-0.1.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "dd2dea3708dcb601037faee15c5ea678",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 33954,
                "upload_time": "2018-03-30T23:22:11",
                "url": "https://files.pythonhosted.org/packages/1c/2d/9bbd258688c6c09b33b307f6aeb99e8d8eb4ed7e98387a4b248568b1a857/faster_particles-0.1.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "9f9ac6c87c85359b9d03b5e1ffd6494d",
                    "sha256": "d30de7071c3405ecbe57d91f8bd81bf773c2dba671a7c93599b32f55a3d30884"
                },
                "downloads": -1,
                "filename": "faster-particles-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "9f9ac6c87c85359b9d03b5e1ffd6494d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27253,
                "upload_time": "2018-03-30T23:21:54",
                "url": "https://files.pythonhosted.org/packages/0c/cf/7b8fe931320a79b795e111d5dd2a4b95c5e76f18435c2ef9487ef071256e/faster-particles-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3a968e8892b444924e580faebd3e5b1b",
                    "sha256": "f7098ed5f96032c3b93ab91a0cdf3c545ad98213c3957bca0bd67291731af564"
                },
                "downloads": -1,
                "filename": "faster_particles-0.1.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3a968e8892b444924e580faebd3e5b1b",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 33956,
                "upload_time": "2018-03-30T23:34:47",
                "url": "https://files.pythonhosted.org/packages/11/a5/ea00db3a9f288d7923e298a28e40a8814090f62a6200a40198d66ff2d514/faster_particles-0.1.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "36816260fba0be81b5b38532c6f93d90",
                    "sha256": "9e6419b89d4826826f6ef1b1e8ea08caac686ae44b1ac8b3d64a3c27c71a367a"
                },
                "downloads": -1,
                "filename": "faster-particles-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "36816260fba0be81b5b38532c6f93d90",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27245,
                "upload_time": "2018-03-30T23:34:30",
                "url": "https://files.pythonhosted.org/packages/a8/96/58c22bb94956657485c64d8d05e50db3a67cb6d7f0e08c3475e119e94e33/faster-particles-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bf98b277112fab14f8ef973411a180e5",
                    "sha256": "e36d70a986a7a5c94fc6e0dfd6137d752c90272a0203e0bb4ce5dad3fadd6b25"
                },
                "downloads": -1,
                "filename": "faster_particles-0.1.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "bf98b277112fab14f8ef973411a180e5",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 34193,
                "upload_time": "2018-03-30T23:53:25",
                "url": "https://files.pythonhosted.org/packages/07/3a/9863066426d05c8de2cbd5bd309ceda91ce252f5a65a0599758a99faadd7/faster_particles-0.1.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "616bfdada526bef1ffbea42bd7ecb2f9",
                    "sha256": "055aef325942e3df7ecd391f39cef1341f55020976a6509b9c753d2bebc34d4c"
                },
                "downloads": -1,
                "filename": "faster-particles-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "616bfdada526bef1ffbea42bd7ecb2f9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27287,
                "upload_time": "2018-03-30T23:53:08",
                "url": "https://files.pythonhosted.org/packages/a3/b1/8088a32a47945fa81b00456a58f40172c24dd28a28803c8e8a5f53125c50/faster-particles-0.1.5.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "80d0de1c589c8a1f46a333324d0a5384",
                    "sha256": "327dc81ec59ad2f0fae16246d643d7b232a75546c694803df362aa9fd9ae7601"
                },
                "downloads": -1,
                "filename": "faster_particles-0.1.6-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "80d0de1c589c8a1f46a333324d0a5384",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 34544,
                "upload_time": "2018-03-31T00:28:01",
                "url": "https://files.pythonhosted.org/packages/8d/bd/23e80bf6418ffb311ac551f9caeba10b8ca766efbe31589cba5f2cc84415/faster_particles-0.1.6-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e49095ec2de0f6446b0c429d8a9b3f8e",
                    "sha256": "280aa8eaa08664badb1950d53210c35f91987e083616200e2aad17d56083aaaa"
                },
                "downloads": -1,
                "filename": "faster-particles-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "e49095ec2de0f6446b0c429d8a9b3f8e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27435,
                "upload_time": "2018-03-31T00:27:47",
                "url": "https://files.pythonhosted.org/packages/4c/44/29998c99b67c8845c327b52c36eeb889a7bcd4bd08eb1ef9ea2557943107/faster-particles-0.1.6.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f654f88ebdc85fb47ca978c70b5b4f51",
                    "sha256": "eea983b65167f2223a6b6d4db1bef8abdfb7d7c2807e1271e41232b809f6e349"
                },
                "downloads": -1,
                "filename": "faster_particles-0.2.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f654f88ebdc85fb47ca978c70b5b4f51",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 36361,
                "upload_time": "2018-04-09T21:06:54",
                "url": "https://files.pythonhosted.org/packages/92/25/5c123cb797dfd11e259098b3a4f915c4acbd4c0d35aa227868ab6f6969ac/faster_particles-0.2.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8287108d666e3656cd6acc6bd2209dea",
                    "sha256": "9e93c483bb00d0bf9b2d5cf274c4646528a25a4db34ae1af6d96dfa506a4e062"
                },
                "downloads": -1,
                "filename": "faster-particles-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8287108d666e3656cd6acc6bd2209dea",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 29515,
                "upload_time": "2018-04-09T21:06:36",
                "url": "https://files.pythonhosted.org/packages/a5/4c/db1fdd64a2d59cd17e37d800db61e858f5f477aac5ae74b8894ecb3335b2/faster-particles-0.2.0.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e2a45925ba63ac74bf25e96aa0676601",
                    "sha256": "78c9ed9f77cc6117be8c4c42f019caf987483942d4e8f5927db657c5652e8145"
                },
                "downloads": -1,
                "filename": "faster_particles-0.2.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e2a45925ba63ac74bf25e96aa0676601",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 37210,
                "upload_time": "2018-04-12T19:17:28",
                "url": "https://files.pythonhosted.org/packages/e2/48/6fdba07abc414345b5ccdd5f2c504c430d63ce6fd6196393d48bf65f2332/faster_particles-0.2.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0b3130366f75c83e020aaa2c3838a4a6",
                    "sha256": "89c6fee986b1d853be9e9b4e4d693004bb2387c4c1c9be20845ad97d0bb744f9"
                },
                "downloads": -1,
                "filename": "faster-particles-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "0b3130366f75c83e020aaa2c3838a4a6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30395,
                "upload_time": "2018-04-12T19:17:16",
                "url": "https://files.pythonhosted.org/packages/1b/9c/6965fbee9ab97a8c45db32c36f3c7d55bdcdaaa62b1b4b59242da8b1bbd2/faster-particles-0.2.1.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ee02ffc4776c521fb99258261f3d802b",
                    "sha256": "ca2fb960994feac8a40759ecd6ba00ebc84233137c0e13a88eaa0cb1462b8dfc"
                },
                "downloads": -1,
                "filename": "faster_particles-0.3.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ee02ffc4776c521fb99258261f3d802b",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 59264,
                "upload_time": "2018-08-03T16:01:37",
                "url": "https://files.pythonhosted.org/packages/48/ec/7cc8a3029a54b7a180113be38ee260e9450506068d1b2a3d08750726d0a8/faster_particles-0.3.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "964b9f0fffb62c1ca5d399a3629af3b9",
                    "sha256": "c8ca13f11d02c1455a5be26d185d491f94807acb8b9f17d9c1eb073bac68acc0"
                },
                "downloads": -1,
                "filename": "faster-particles-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "964b9f0fffb62c1ca5d399a3629af3b9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 46217,
                "upload_time": "2018-08-03T16:01:16",
                "url": "https://files.pythonhosted.org/packages/6a/c3/124a3fa425f284e0692f47864aba04ee2f70bf823655733b18e86077da5f/faster-particles-0.3.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ee02ffc4776c521fb99258261f3d802b",
                "sha256": "ca2fb960994feac8a40759ecd6ba00ebc84233137c0e13a88eaa0cb1462b8dfc"
            },
            "downloads": -1,
            "filename": "faster_particles-0.3.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ee02ffc4776c521fb99258261f3d802b",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 59264,
            "upload_time": "2018-08-03T16:01:37",
            "url": "https://files.pythonhosted.org/packages/48/ec/7cc8a3029a54b7a180113be38ee260e9450506068d1b2a3d08750726d0a8/faster_particles-0.3.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "964b9f0fffb62c1ca5d399a3629af3b9",
                "sha256": "c8ca13f11d02c1455a5be26d185d491f94807acb8b9f17d9c1eb073bac68acc0"
            },
            "downloads": -1,
            "filename": "faster-particles-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "964b9f0fffb62c1ca5d399a3629af3b9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 46217,
            "upload_time": "2018-08-03T16:01:16",
            "url": "https://files.pythonhosted.org/packages/6a/c3/124a3fa425f284e0692f47864aba04ee2f70bf823655733b18e86077da5f/faster-particles-0.3.0.tar.gz"
        }
    ]
}