{ "info": { "author": "Charles H. Camp Jr.", "author_email": "charles.camp@nist.gov", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Environment :: X11 Applications :: Qt", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "Operating System :: OS Independent", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering :: Visualization" ], "description": ".. -*- mode: rst -*-\n\n.. image:: https://travis-ci.com/CCampJr/CRIkit2.svg?branch=master\n :alt: Travis CI Status\n :target: https://travis-ci.com/CCampJr/CRIkit2\n\n.. image:: https://ci.appveyor.com/api/projects/status/1yrsrk6wfhjsn7bq/branch/master?svg=true\n :alt: AppVeyor CI Status\n :target: https://ci.appveyor.com/project/CCampJr/crikit2\n\n.. image:: https://codecov.io/gh/CCampJr/CRIkit2/branch/master/graph/badge.svg\n :alt: Codecov\n :target: https://codecov.io/gh/CCampJr/CRIkit2\n\n.. image:: https://img.shields.io/pypi/pyversions/CRIkit2.svg\n :alt: PyPI - Python Version\n :target: https://pypi.org/project/CRIkit2/\n\n.. image:: https://img.shields.io/pypi/v/CRIkit2.svg\n :alt: PyPI Project Page\n :target: https://pypi.org/project/CRIkit2/\n\n.. image:: https://img.shields.io/badge/License-NIST%20Public%20Domain-green.svg\n :alt: NIST Public Domain\n :target: https://github.com/CCampJr/CRIkit2/blob/master/LICENSE.md\n\n\nCRIKit2: Hyperspectral imaging toolkit\n=======================================\n\n.. image:: https://raw.githubusercontent.com/CCampJr/CRIkit2/master/docs/source/_static/CRIkit2_Logo.png\n :alt: CRIkit2 Logo\n\nCRIKit2, formerly the Coherent Raman Imaging toolKit, is a hyperspectral\nimaging (HSI) platform. It is composed of command line tools, interactive tools,\nand a user interface.\n\nGithub Repository: https://github.com/CCampJr/CRIkit2\nDocs Website: Coming Soon...\n\n**Note:** Help Documentation available via the Help header within the CRIkit2 GUI\n\nHSI Processing:\n\n- Dark subtraction\n- Detrending\n- Denoising via SVD\n\nCoherent Raman-Specific Processing:\n\n- Kramers-Kronig phase retrieval\n- Phase- and scale-error correction\n\nComing Soon:\n\n- SVD automated selection tools\n- Analysis toolkit (separate UI)\n- Interactive Raman database\n- Much more\n\nNotices\n--------\n\n- Major bug fix in 0.2.1 (`Issue #84 `_)\n\nDependencies\n-------------\n\nNote: These are the developmental system specs. Older versions of certain\npackages may work.\n\n- python >= 3.4\n - Tested with 3.4.4, 3.5.2, 3.6.1, 3.7.2\n\n- NumPy\n- SciPy\n- matplotlib (1.*, 2.*, 3.*)\n- packaging\n- PyQT5\n- CVXOPT\n\n- LazyHDF5 >= 0.2.2\n\n - Requires H5Py (>= 2.6)\n\n- SciPlot-PyQt >= 0.2.2\n\n - https://github.com/CCampJr/SciPlot-PyQt/releases\n - Requires Matplotlib (v1.*, 2.*, or 3.*)\n\n- Sphinx (optional)\n\nIMPORTANT: For Python 3.4\n~~~~~~~~~~~~~~~~~~~~~~~~~~\nYou will need to manually install PyQt5 and Qt5 or get it through a distribution:\n\n- PyQt5: https://www.riverbankcomputing.com/software/pyqt/download5\n- Qt: https://www.qt.io/\n\nFor Python 3.5, installation through pip available\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code::\n\n pip3 install pyqt5\n\nKnown Issues\n-------------\n\nWindows 10 with High-Resolution Monitors\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe GUI may appear squashed with small font. There is a work-around described at https://github.com/CCampJr/CRIkit2/issues/79\n\nPyQt 5.7.*\n~~~~~~~~~~~\n\nThere is a bug in PyQt 5.7.* that will prevent SciPlot's tables from showing the individual plot entries \n(see https://www.riverbankcomputing.com/pipermail/pyqt/2017-January/038483.html). Apparently, this will be fixed in 5.7.2.\n\n- As WinPython 3.5.2.3Qt5 and 3.5.2.2Qt5 use PyQt 5.7.*, it is advised to use WinPython 3.5.2.1Qt5 or 3.4.4.5Qt5 until the matter is sorted out.\n- Alternatively, one can uninstall pyqt5.7.* and force an install of <= 5.6.*.\n\n\nInstallation\n-------------\n\nIt is advisable to clone CRIkit2 via git (https://git-scm.com/) and install\nin a *developmental* mode via *pip* or *conda* as this will enable you to\neasily (relatively) update your copy of CRIkit2 as new functionality\nis *pushed*.\n\n**Note** If you choose to clone an updatable copy of CRIkit2, do not\nclone to a directory within your Python installation. Rather, create a new\ndirectory elsewhere. That way if you update your Python distribution, you won't\nlose your copy of CRIkit2.\n\nOption 1: Dynamic, Updatable Clone of CRIkit2\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code::\n\n # Note: in Windows, commands will be followed by .exe\n # Note: On multi-python systems, you should probably append a 3 to end\n # the end of commands, e.g., pip is pip3, python is python3\n\n # Assume the new directory will be CRIkit2 (it can be anything)\n # Clone from github\n git clone https://github.com/CCampJr/crikit2.git CRIkit2\n\n # Within install directory\n pip install -e .\n\n # To update installation, from within the CRIkit2 directory\n git pull\n\n # If you receive an error trying to update via git pull\n # See https://github.com/CCampJr/CRIkit2/issues/82\n\n \nOption 2: Static Copy\n~~~~~~~~~~~~~~~~~~~~~~\n\nThe static copy will copy the CRIkit2 install into your Python distribution\nand will not be updatable without re-installing CRIkit2\n\n.. code::\n\n # Note: in Windows, commands will be followed by .exe\n # Note: On multi-python systems, you should probably append a 3 to end\n # the end of commands, e.g., pip is pip3, python is python3\n\n # Assume the new directory will be CRIkit2 (it can be anything)\n # Clone from github\n git clone https://github.com/CCampJr/crikit2.git CRIkit2\n\n # Within install directory\n pip install .\n\n # You can now delete the source files you downloaded if so desired\n\n # To update installation, from within the CRIkit2 directory\n git pull\n pip install .\n\nOption 3: Installation via pip\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: \n\n pip install CRIkit2\n\n\n(Re-) Building Documentation\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nA pre-built version of the documentation is included with the installation;\nthus, this step should not be necessary unless you are making modifications\nto the software.\n\nThe documentation is accessible from within CRIkit2 under the *Help* header.\nIt is displayed in a web browser.\n\n.. code::\n\n # From within the CRIkit2 directory (not crikit)\n cd docs\n\n # Clean out old docs (optional)\n make clean # On Windows make.bat clean\n\n # Build API w/o pyuic5-generated files\n # Windows add .exe\n sphinx-apidoc -f -o ./source/ ../ ../crikit/ui/qt_* ../crikit/ui/*_rc* ../crikit/ui/old/** ../setup.py\n\n make html # On Windows make.bat html\n\n\nStarting the CRIkit2 UI\n------------------------\n\n.. code::\n\n python3 -m crikit \n\n # or\n\n python -m crikit\n\nKnown Operational Nuances\n--------------------------\n\n- The SVD visualization tool uses a complex-valued SVD for complex values; thus, there are a few\n things to avoid\n\n - If your spectra are PURELY IMAGINARY, convert them to PURELY REAL\n - If your real and imaginary parts of your spectra are IDENTICAL, then\n consider using just the real or imaginary portion\n - NOTE: this does not affect the accuracy or performance of SVD or the returned\n results, but you will see unexpected visualizations of the spatial and spectral\n components.\n\nLICENSE\n----------\nThis software was developed by employees of the National Institute of Standards \nand Technology (NIST), an agency of the Federal Government. Pursuant to \n`title 17 United States Code Section 105 `_, \nworks of NIST employees are not subject to copyright protection in the United States and are \nconsidered to be in the public domain. Permission to freely use, copy, modify, \nand distribute this software and its documentation without fee is hereby granted, \nprovided that this notice and disclaimer of warranty appears in all copies.\n\nTHE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER \nEXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY \nTHAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF \nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM INFRINGEMENT, \nAND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE SOFTWARE, OR ANY \nWARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT SHALL NIST BE LIABLE \nFOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL OR \nCONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR IN ANY WAY CONNECTED \nWITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, CONTRACT, TORT, OR \nOTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR PROPERTY OR \nOTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT OF THE \nRESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.\n\nCITATION\n---------\n\n`C H Camp Jr, Y J Lee, and M T Cicerone, \"Quantitative, comparable coherent\nanti-Stokes Raman scattering (CARS) spectroscopy: correcting errors in phase\nretrieval\", Journal of Raman Spectroscopy 47, 408-416 (2016). `_\n\n\n\n\nContact\n--------\n\nCharles H Camp Jr: `charles.camp@nist.gov `_", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/CCampJr/CRIkit2", "keywords": "", "license": "Public Domain", "maintainer": "", "maintainer_email": "", "name": "CRIkit2", "package_url": "https://pypi.org/project/CRIkit2/", "platform": "", "project_url": "https://pypi.org/project/CRIkit2/", "project_urls": { "Homepage": "https://github.com/CCampJr/CRIkit2" }, "release_url": "https://pypi.org/project/CRIkit2/0.2.1/", "requires_dist": null, "requires_python": "", "summary": "Hyperspectral imaging (HSI) processing and analysis platform (user interface, UI)", "version": "0.2.1" }, "last_serial": 5843422, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "39bbd8ed043535d15a5c41f45ce7d1e7", "sha256": "f1126dab0053b38f78e17c0b403e5c09545309b561b3982372057c314ba0c283" }, "downloads": -1, "filename": "CRIkit2-0.2.0.tar.gz", "has_sig": false, "md5_digest": "39bbd8ed043535d15a5c41f45ce7d1e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26340382, "upload_time": "2019-05-23T21:03:08", "url": "https://files.pythonhosted.org/packages/77/9a/bd1bdbc5751cd257578b03ad226b8c342dd4cb245cabcb964d4f4e8b5be7/CRIkit2-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "c0613bb5bbc324f64b0116c2aa1c1a34", "sha256": "00c036b892c801aad432ddc73ee7d71a2ecbd3bc3e1b2f710e0247ace0906ad7" }, "downloads": -1, "filename": "CRIkit2-0.2.1.tar.gz", "has_sig": false, "md5_digest": "c0613bb5bbc324f64b0116c2aa1c1a34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20946381, "upload_time": "2019-09-17T18:53:57", "url": "https://files.pythonhosted.org/packages/af/11/2401fcd63ca0a8834c8d9a2c3c8dad783eafbb876b60525703f826e78c90/CRIkit2-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c0613bb5bbc324f64b0116c2aa1c1a34", "sha256": "00c036b892c801aad432ddc73ee7d71a2ecbd3bc3e1b2f710e0247ace0906ad7" }, "downloads": -1, "filename": "CRIkit2-0.2.1.tar.gz", "has_sig": false, "md5_digest": "c0613bb5bbc324f64b0116c2aa1c1a34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20946381, "upload_time": "2019-09-17T18:53:57", "url": "https://files.pythonhosted.org/packages/af/11/2401fcd63ca0a8834c8d9a2c3c8dad783eafbb876b60525703f826e78c90/CRIkit2-0.2.1.tar.gz" } ] }