{ "info": { "author": "Kevin Kramer", "author_email": "kevin.kramer@uzh.ch", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# ARPYS: python module for ARPES (**A**ngle **R**esolved **P**hoto**E**mission **S**pectroscopy) data analysis \n\n![](https://raw.githubusercontent.com/kuadrat/arpys/master/screenshots/pit_demo.gif)\n\nThis repository consists of libraries, programs and scripts related to ARPES \ndata analysis.\nThe software contained in this repository is distributed under the GNU \nGeneral Public License v3+. See file 'COPYING' for more information.\nThe file 'LICENSE-3RD-PARTY.txt' covers the different licenses of libraries \nand other programs used by ARPYS.\n\n## Requirements\n\nThe requirements are listed in `requirements.txt`. Most notable are \n`pyqtgraph`, a nice library that's built on PyQt and allows fast real-time \ndata visualization. Consequently, `arpys` requires `PyQt5` and its dependency \n`SIP`. Confer `INSTALLING.md` for more info.\n\n## Installation\n\nPlease refer to the file `INSTALLING.md`\n\n## Rough description of contents\n\nThe recommended way of using `arpys` currently is to make use of the classes \nin `dataloaders.py` (if the beamline in question has already been implemented) \nto get the relevant data into a usable format in python. Then, one can use the\nfunctions provided in `postprocessing.py` (normalizations, background \nsubtractions, etc.) on the so loaded data. Here's a simple example:\n```\n# Import the dataloaders and postprocessings\nfrom arpys import dl, pp \n\n# Load the data (this requires an appropriate dataloader to be defined in \n# dataloaders.py. If it isn't, check the file to see how you should define it\n# in your case.\nD = dl.load_data('your_arpes_data_file.suffix')\n\n# D is a Namespace object which stores the data array and some meta-data.\n# In this example we're assuming the data to contain a single energy-k cut.\n# arpys always loads data as 3d-arrays, however, so we need to take D.data[0]\n# here.\ndata = D.data[0]\nenergies = D.xscale\nangles = D.yscale\n\n# Apply some background subtraction (use at your own discretion):\nbg_subtracted = pp.subtract_bg_matt(data)\n\n# Try taking the second derivative to make the bands more visible. This often\n# requires smoothing first and is very susceptible to the various parameters.\nfrom scipy.ndimage import filters\nsmoothened = filters.gaussian_filter(bg_subtracted, sigma=10)\ndx = energies[1] - energies[0]\ndy = angles[1] - angles[0]\nsecond_derivative = pp.laplacian(smoothened, dx, dy)\n```\n\nThe tools that ship with `arpys` should be considered to be in an untested \nstage and used at your own discretion.\n\npostprocessing.py\n-----------------\n\nLibrary-like module that contains functions to process ARPES data, like \nnormalizations, bg subtractions, derivative methods, etc.\n\ndataloaders.py\n--------------\n\nContains classes which handle reading of ARPES data from different beamlines \n(i.e. different data format and conventions) and passing it in a fixed, \npython-friendly format for use by other tools and scripts in this module.\n\narpes_plot.py\n-------------\n\nImplements a commad-line interpreter that allows quick visualization of data \nand provides some basic postprocessing options (like cropping, normalization, \nangle-to-k conversion,...)\nCan be used as a program from the command line (possibly after a `chmod 755 \narpes_plot.py`) by\n```Bash\n$ arpes_plot.py \n```\n\npit\n---\n\nThe **P**ython **I**mage **T**ool: A graphical data analysis tool (in the \nmaking) based on the `pyqtgraph` module.\n\ntools/\n------\n\nA set of little scripts and command-line tools for specific jobs.\nConfer each tools respective documentation for more info.\n\n#### gui.py\n\n[Deprecated] A GUI which allows to take quick looks at cuts and maps. This is \nbuilt with tkinter and matplotlib and, consequently, is rather slow.\nIn most cases `arpes_plot.py` should be used instead.\n\n#### apc\n\nA link to `arpes_plot.py`\n\n#### bandcharacters.py\n\nA tool to plot the band characters from a wien2k DFT calculation.\n\nutilities/\n----------\n\nA submodule that contains some custom python code that the original author \nused on his system and got incorporated into arpys.\narpys mostly needs the axes subclasses and some small helper functions from \nthere.\nThis is actually just a copy of another module that is hosted at \n.\n\n================================================================================\nCopyright (c) 2018 Kevin Kramer, Universit\u00e4t Z\u00fcrich (kevin.kramer@uzh.ch)\n\n\n\n", "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/kuadrat/arpys.git", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "arpys", "package_url": "https://pypi.org/project/arpys/", "platform": "", "project_url": "https://pypi.org/project/arpys/", "project_urls": { "Homepage": "https://github.com/kuadrat/arpys.git" }, "release_url": "https://pypi.org/project/arpys/0.1.5/", "requires_dist": [ "cmd2 (>=0.9.1)", "cycler (>=0.10.0)", "h5py (>=2.7.1)", "ipykernel (>=4.8.2)", "ipython (<7.0.0,>=5.5.0)", "ipython-genutils (>=0.2.0)", "igor (>=0.3)", "jupyter-client (>=5.2.3)", "jupyter-core (>=4.4.0)", "matplotlib (>=2.1.0)", "numpy (>=1.8.0)", "pickleshare (>=0.7.4)", "qtconsole (>=4.3.1)", "scipy (>=0.19.1)", "screeninfo (>=0.3)", "pyfits (>=3.4)", "PyQt5 (>=5.5.1)", "pyqtgraph (>=0.10.0)" ], "requires_python": "", "summary": "Python tools and scripts for ARPES data analysis", "version": "0.1.5" }, "last_serial": 5715394, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "eef6ec4b6f737c19494189d7841e6ea5", "sha256": "3c97d636a6ebe7642e4f75361733b440522dd49e93ef023d77f4201b1a32f7c9" }, "downloads": -1, "filename": "arpys-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "eef6ec4b6f737c19494189d7841e6ea5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 104257, "upload_time": "2018-09-24T03:35:50", "url": "https://files.pythonhosted.org/packages/8d/a6/9f4f61d348725d7cce6f3fd3283013684e61c5121d40e940e36935ae65da/arpys-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "290f42635dfa46d5dc563b006a5798e5", "sha256": "88abaab8ebe50f2e7e22ab32d8cf10eef18d48430dd2aeb254c0b5b05458a56c" }, "downloads": -1, "filename": "arpys-0.1.0.tar.gz", "has_sig": false, "md5_digest": "290f42635dfa46d5dc563b006a5798e5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 80171, "upload_time": "2018-09-24T03:35:52", "url": "https://files.pythonhosted.org/packages/f7/88/2c03eb8d852f141571aa1ee0c1c48cd329d6ac4ed7c324a6483e17d32698/arpys-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "2747e4c852f075755653f30e67d031bc", "sha256": "08724ae0c1137e429ddcb4f17b7f2b4e99b211d5fbc8507de1e80d19c28e6e20" }, "downloads": -1, "filename": "arpys-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2747e4c852f075755653f30e67d031bc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2021097, "upload_time": "2019-02-24T22:49:22", "url": "https://files.pythonhosted.org/packages/af/c2/5ed75386bf7309051c7088902a5b4b741293bfbb90ac4f1ceabafe4c2ae3/arpys-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "059b2aab68426b1d1eb1bc4a657be3e7", "sha256": "c9e8000021828fd17052e8d92ccb5db5bf4bdedbf0da01305c985e55dc78692b" }, "downloads": -1, "filename": "arpys-0.1.1.tar.gz", "has_sig": false, "md5_digest": "059b2aab68426b1d1eb1bc4a657be3e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2015813, "upload_time": "2019-02-24T22:49:26", "url": "https://files.pythonhosted.org/packages/c7/43/b98865242bcf7483d26e6918d9e0340dacf7e7b887956e7590bf73786f58/arpys-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "c22689d8644bcd5e5e3493b3664c7747", "sha256": "7545798ba90aa87547f7c2c197e6c9245ef53a05fc8d1fa66e9fc8ef1db8d799" }, "downloads": -1, "filename": "arpys-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c22689d8644bcd5e5e3493b3664c7747", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2039652, "upload_time": "2019-03-07T10:51:55", "url": "https://files.pythonhosted.org/packages/90/29/1e50e52b31f16870075edfc5c7eb6dbd4f053b781731087a8e12e9b547d7/arpys-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a9fd6baef3125f7373882b911625bb9c", "sha256": "cbcc0c611e1e3d62fe392bbe00e67b826604f079ca0b351ab7846f7c7fbc720b" }, "downloads": -1, "filename": "arpys-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a9fd6baef3125f7373882b911625bb9c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2030424, "upload_time": "2019-03-07T10:51:59", "url": "https://files.pythonhosted.org/packages/17/5c/dfb65e178d79392fe0ac803deb0853807da3c0bb0b247548cfc747cbcb10/arpys-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "46d05653273f1a86fc06e0e0d68d89cc", "sha256": "e8a99b2fa312347700ff0570836a07a467fe0372c28a517e144574ef5794171e" }, "downloads": -1, "filename": "arpys-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "46d05653273f1a86fc06e0e0d68d89cc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2039768, "upload_time": "2019-03-07T11:32:23", "url": "https://files.pythonhosted.org/packages/ad/57/b5e509dd9f2728e58a8eba2dc48ff56b130511026fd6b041b758df31311c/arpys-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3e296808bd1e6e53ecd9aefdd4f85320", "sha256": "1e09afd79b32440c834d18938b0f1996788d4cb5bbd7a5cda092484182667e2a" }, "downloads": -1, "filename": "arpys-0.1.3.tar.gz", "has_sig": false, "md5_digest": "3e296808bd1e6e53ecd9aefdd4f85320", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2030488, "upload_time": "2019-03-07T11:32:25", "url": "https://files.pythonhosted.org/packages/1a/b5/e7ad92f892ce7c6ff9b11a73a557824f9a87f37769c91691b9cb950a686a/arpys-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "645c4e7cd1b552a1a127e25f12d40658", "sha256": "c16c5d8aeea0cf52a00d358d534c027c93cf69bb3bc3dd86c0dfad9a5d92361f" }, "downloads": -1, "filename": "arpys-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "645c4e7cd1b552a1a127e25f12d40658", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2040111, "upload_time": "2019-03-07T13:54:09", "url": "https://files.pythonhosted.org/packages/a2/25/17419d612b7150d9c58ed5248cbffec936a1ad1d6c1b5400afec62f00c43/arpys-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86963ca9d46361deafda08c3dbfa80e7", "sha256": "d23d9fd989564d4f034afaff1f3fc5b49eb2a022cd75d71aaa7d9538bb278b36" }, "downloads": -1, "filename": "arpys-0.1.4.tar.gz", "has_sig": false, "md5_digest": "86963ca9d46361deafda08c3dbfa80e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2030620, "upload_time": "2019-03-07T13:54:12", "url": "https://files.pythonhosted.org/packages/78/17/3780b4434d57ecb0a8c5f2edc62a3653f5189366d44d694520d2b41bb8d9/arpys-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "aeaa3b06fe5798e8406e5cc9e8c67a8f", "sha256": "7d19185109628339bfe37faa7c17a01fb8182ab8d0b5eeb4fe172f64de992faf" }, "downloads": -1, "filename": "arpys-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "aeaa3b06fe5798e8406e5cc9e8c67a8f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2044773, "upload_time": "2019-08-22T13:55:04", "url": "https://files.pythonhosted.org/packages/70/d6/d4a2fb28e0dade68378e1d39cc68d65f339a2312765805a8558fefe4982c/arpys-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e2f58248e12e6b8dfc5f7c1aad56eaca", "sha256": "18bab91e6d380228ab4eaa104b5b51c906386803dfb9ca4e25af588154e4f300" }, "downloads": -1, "filename": "arpys-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e2f58248e12e6b8dfc5f7c1aad56eaca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2034403, "upload_time": "2019-08-22T13:55:08", "url": "https://files.pythonhosted.org/packages/dd/1b/7401e5e4ce32ea62690cd61b50e93fc06beea8a51f4b889903e1ab4cb899/arpys-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aeaa3b06fe5798e8406e5cc9e8c67a8f", "sha256": "7d19185109628339bfe37faa7c17a01fb8182ab8d0b5eeb4fe172f64de992faf" }, "downloads": -1, "filename": "arpys-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "aeaa3b06fe5798e8406e5cc9e8c67a8f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2044773, "upload_time": "2019-08-22T13:55:04", "url": "https://files.pythonhosted.org/packages/70/d6/d4a2fb28e0dade68378e1d39cc68d65f339a2312765805a8558fefe4982c/arpys-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e2f58248e12e6b8dfc5f7c1aad56eaca", "sha256": "18bab91e6d380228ab4eaa104b5b51c906386803dfb9ca4e25af588154e4f300" }, "downloads": -1, "filename": "arpys-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e2f58248e12e6b8dfc5f7c1aad56eaca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2034403, "upload_time": "2019-08-22T13:55:08", "url": "https://files.pythonhosted.org/packages/dd/1b/7401e5e4ce32ea62690cd61b50e93fc06beea8a51f4b889903e1ab4cb899/arpys-0.1.5.tar.gz" } ] }