{
    "info": {
        "author": "Padraic Shafer",
        "author_email": "pshafer@lbl.gov",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Topic :: Scientific/Engineering :: Physics"
        ],
        "description": "# ALS.Milo (version 0.15)\n\nOverview\n---\n_**Milo**_ is a suite of Python modules used to read, process, and analyze \ndata that was collected on the **Scattering Chamber** located at \n**Beamline 4.0.2** (_a.k.a. **BL402**_) of the **Advanced Light Source** \n(Berkeley, CA USA).\n\nIt is distributed under the _namespace package_, _**ALS**_. \n\nInstallation\n---\n### Install from PyPI\n**_ALS.Milo_** can be installed from PyPI using `pip`.\nThe following example shows how.\n```bash\n>> sudo pip install ALS.Milo\n```\n### Install from local repository (download)\n**_ALS.Milo_** can be installed from a local copy of the project repository \nusing `pip`. The following example shows how.\n```bash\n>> cd ALS.Milo-0.15.1/  # Local directory of project repository\n>> sudo pip install .\n```\n\nBackground information\n---\nData from the BL402 Scattering Chamber is stored in two types of files:\n* **FITS files**: Each image captured by the CCD (_a.k.a._ the camera) is \nstored in a separate file using the _FITS_ format. _More details below._\nhttps://fits.gsfc.nasa.gov/fits_documentation.html\n* **Scan summary files**: When a scan sequence is run to collect data, a text \nfile is created to summarize the parameters of the scan and the data collected.\n\n   Every _scan summary file_ contains a header that describes the scan and the \ntypes of data recorded, followed by data rows -- one row per data point. An \n_Instrument Scan_ provides an _image filename_ in each data row that can be \nused to access the CCD images recorded during the scan.\n\nUsage\n---\n`class CcdImageFromFITS` encapsulates the operations of loading CCD data \nfrom a FITS file (including header information), accessing that data, and \nconverting CCD screen coordinates (pixels) into reciprocal space coordinates.\n\nThe following command can be used \nto access the `CcdImageFromFITS` class in the `qimage` module.\n```python\nfrom als.milo.qimage import CcdImageFromFITS\n```\n\nTo read a FITS file use the constructor:  \n`CcdImageFromFITS(`*`filename`*`)` ,  \nwhere _filename_ is a reachable (relative or absolute) file path to the FITS \nfile.\n\nThe two-dimensional array of data can be accessed through the instance member, \n`data`.\n```python\nccd_image = CcdImageFromFITS(\"NiFe_8044-00024.fits\")\nccd_image.data  # 2D array with shape (num_rows, num_columns)\n```\n\nReciprocal space coordinates are calculated for each pixel using the member \nfunction, `qvalues_df()`. The return value is a PANDAS dataframe (_df_) where \neach row corresponds to a single pixel. The columns `[\"Qx\", \"Qy\", \"Qz\"]` are \nthe diffractometer coordinates of the reciprocal space vector in units of \nnm<sup>-1</sup> (_Q_ = 2&pi; / _d_). Intensity of each pixel is in column, \n`\"Counts\"`.\n```\nccd_image = CcdImageFromFITS(\"NiFe_8044-00024.fits\")\nq_ccd_df = ccd_image.qvalues_df()\nq_ccd_df[\"Qx\", \"Qy\", \"Qz\", \"Counts\"]    # CCD data in reciprocal space\n```\n\nCopyright Notice\n---\nALS.Milo: BL402 RSXD Data Analysis, Copyright (c) 2014-2019, The Regents of \nthe University of California, through Lawrence Berkeley National Laboratory \n(subject to receipt of any required approvals from the U.S. Dept. of Energy). \nAll rights reserved.\n\nIf you have questions about your rights to use or distribute this software, \nplease contact Berkeley Lab's Intellectual Property Office at IPO@lbl.gov.\n\nNOTICE. This Software was developed under funding from the U.S. Department of \nEnergy and the U.S. Government consequently retains certain rights. As such, \nthe U.S. Government has been granted for itself and others acting on its \nbehalf a paid-up, nonexclusive, irrevocable, worldwide license in the \nSoftware to reproduce, distribute copies to the public, prepare derivative \nworks, and perform publicly and display publicly, and to permit other to do \nso.",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://bitbucket.org/berkeleylab/als.milo/src/master/",
        "keywords": "CCD RSXD XRMS XRMR x-ray ALS BL4.0.2 diffraction",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ALS.Milo",
        "package_url": "https://pypi.org/project/ALS.Milo/",
        "platform": "",
        "project_url": "https://pypi.org/project/ALS.Milo/",
        "project_urls": {
            "Homepage": "https://bitbucket.org/berkeleylab/als.milo/src/master/"
        },
        "release_url": "https://pypi.org/project/ALS.Milo/0.15.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Setup & analyze data from ALS BL 4.0.2 diffractometer",
        "version": "0.15.1"
    },
    "last_serial": 5371603,
    "releases": {
        "0.15.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2085395fe0b23483438a62d2086d5fdd",
                    "sha256": "c7bad8060a56040dcf2a4d9ad1fd5253fa5901b81c7817c5f81dfafb16f0a3ad"
                },
                "downloads": -1,
                "filename": "ALS.Milo-0.15.0.tar.gz",
                "has_sig": false,
                "md5_digest": "2085395fe0b23483438a62d2086d5fdd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 51321,
                "upload_time": "2019-05-27T17:29:31",
                "url": "https://files.pythonhosted.org/packages/a5/b3/f0633ff273c0ceb06f25544995a3a84b04f9047da9a7b11badc67010a92d/ALS.Milo-0.15.0.tar.gz"
            }
        ],
        "0.15.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5e3f0d1e3d75327030dc6794f6d7d4be",
                    "sha256": "dba0e652e596c9ebc0a957ccc065e10e6431ba828bba31c15ef19ca7651910cd"
                },
                "downloads": -1,
                "filename": "ALS.Milo-0.15.1.tar.gz",
                "has_sig": false,
                "md5_digest": "5e3f0d1e3d75327030dc6794f6d7d4be",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 51225,
                "upload_time": "2019-06-07T13:48:13",
                "url": "https://files.pythonhosted.org/packages/2d/a7/a6dc1079499a381c46ef0cded79887f59a1a0e331d37fb695b38470cfc45/ALS.Milo-0.15.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5e3f0d1e3d75327030dc6794f6d7d4be",
                "sha256": "dba0e652e596c9ebc0a957ccc065e10e6431ba828bba31c15ef19ca7651910cd"
            },
            "downloads": -1,
            "filename": "ALS.Milo-0.15.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5e3f0d1e3d75327030dc6794f6d7d4be",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 51225,
            "upload_time": "2019-06-07T13:48:13",
            "url": "https://files.pythonhosted.org/packages/2d/a7/a6dc1079499a381c46ef0cded79887f59a1a0e331d37fb695b38470cfc45/ALS.Milo-0.15.1.tar.gz"
        }
    ]
}