{ "info": { "author": "Dominic Davis-Foster", "author_email": "dominic@davis-foster.co.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: End Users/Desktop", "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Education", "Topic :: Scientific/Engineering :: Bio-Informatics", "Topic :: Scientific/Engineering :: Chemistry", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "************\nPyMassSpec\n************\n\n.. image:: https://travis-ci.org/domdfcoding/pymassspec.svg?branch=master\n :target: https://travis-ci.org/domdfcoding/pymassspec\n :alt: Build Status\n.. image:: https://readthedocs.org/projects/pymassspec/badge/?version=latest\n :target: https://pymassspec.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://img.shields.io/pypi/v/pymassspec.svg\n :target: https://pypi.org/project/pymassspec/\n :alt: PyPI\n.. image:: https://img.shields.io/pypi/pyversions/pymassspec.svg\n :target: https://pypi.org/project/pymassspec/\n :alt: PyPI - Python Version\n.. image:: https://coveralls.io/repos/github/domdfcoding/pymassspec/badge.svg?branch=master\n :target: https://coveralls.io/github/domdfcoding/pymassspec?branch=master\n :alt: Coverage\n\n\nA Python toolkit for processing of chromatography--mass spectrometry data\n\nPyMassSpec is a Python_ package for processing gas chromatography-mass spectrometry data.\nPyMassSpec provides a framework and a set of components for rapid development and testing of methods for processing of chromatography--mass spectrometry data.\nPyMassSpec can be used interactively through the Python shell, or the functions can be collected into scripts when it is preferable to perform data processing in the batch mode.\n\n|\n\nOriginally by Andrew Isaac, Sean O'Callaghan and Vladimir Liki\u0107\n\nThe original publication can be found here: https://bmcbioinformatics.biomedcentral.com/articles/10.1186/1471-2105-13-115\n\n\nForked from the original PyMS Repository: https://github.com/ma-bio21/pyms.\n\nThe original project seems to have been abandoned as there has been no activity in 18 months.\n\n\n.. contents:: Table of Contents\n\n\n\nThe PyMassSpec project\n=========================\n\nThe directory structure of PyMassSpec is as follows:\n\n.. code-block:: text\n\n /\n \u251c\u2500\u2500 pyms: The PyMassSpec code\n \u2502\n \u251c\u2500\u2500 pyms-data: Example GC-MS data files\n \u2502\n \u251c\u2500\u2500 pyms-demo: Examples of how to use PyMassSpec\n \u2502\n \u251c\u2500\u2500 tests: pytest tests\n \u2502\n \u2514\u2500\u2500 UserGuide: Sphinx source for documentation\n\nFeatures\n=========\n\nInstallation\n==============\n\nPyMassSpec can be installed with the following command:\n\n.. code-block:: bash\n\n $ pip --user install PyMassSpec\n\nThis will also install the following dependencies:\n\n.. code-block:: bash\n\n numpy >= 1.16.2\n scipy >= 1.2.1\n pymzml >= 2.2.1\n matplotlib >= 3.0.2\n openpyxl >= 2.6.2\n netCDF4 >= 1.5.0\n biopython >= 1.74\n deprecation >= 2.0.6\n\n\nPyMassSpec also requires 'mp4py', installation instructions for which can be found at: https://mpi4py.readthedocs.io/en/stable/\n\n\nUsage\n=======\n\nA tutorial illustrating various PyMassSpec features in detail is provided\nin subsequent chapters of this User Guide. The commands executed\ninteractively are grouped together by example, and can be found\n`here `__.\n\n.. If you are viewing this source, the examples can be found in the pyms-demo directory, and the data files in pyms-data\n\nThe data used in the PyMassSpec documentation and examples is available\n`here `__.\n\nIn the \"`Demos and Examples `__\" section there\nis a page corresponding to each example, coded with the chapter number\n(ie. \"`pyms-demo/20a/`\" corresponds to the Example 20a, from Chapter 2).\n\nEach example has a script named 'proc.py' which contains the commands given in the example.\nThese scripts can be run with the following command:\n\n.. code-block:: bash\n\n $ python3 proc.py\n\nExample processing GC-MS data\n-------------------------------\n\nDownload the file ``gc01_0812_066.jdx`` and save it in the folder ``data``.\nThis file contains GC-MS data in the the JCAMP-DX format.\n\nFirst the raw data is loaded:\n\n >>> from pyms.GCMS.IO.JCAMP import JCAMP_reader\n >>> jcamp_file = \"data/gc01_0812_066.jdx\"\n >>> data = JCAMP_reader(jcamp_file)\n -> Reading JCAMP file 'Data/gc01_0812_066.jdx'\n >>> data\n \n\nThe intensity matrix object is then built by binning the data:\n\n >>> from pyms.IntensityMatrix import build_intensity_matrix_i\n >>> im = build_intensity_matrix_i(data)\n\nIn this example, we show how to obtain the dimensions of the\nnewly created intensity matrix, then loop over all ion chromatograms,\nand for each ion chromatogram apply Savitzky-Golay noise filter\nand tophat baseline correction:\n\n >>> n_scan, n_mz = im.size\n >>> from pyms.Noise.SavitzkyGolay import savitzky_golay\n >>> from pyms.TopHat import tophat\n >>> for ii in range(n_mz):\n ... print(\"working on IC\", ii)\n ... ic = im.get_ic_at_index(ii)\n ... ic1 = savitzky_golay(ic)\n ... ic_smooth = savitzky_golay(ic1)\n ... ic_base = tophat(ic_smooth, struct=\"1.5m\")\n ... im.set_ic_at_index(ii, ic_base)\n\nThe resulting noise and baseline corrected ion chromatogram is saved back into the intensity matrix.\n\nFurther examples can be found in the `documentation`_\n\nContributing\n==============\n\nContributions are very welcome. Tests can be run with `pytest`_. Please\nensure the coverage is at least .. image:: https://coveralls.io/repos/github/domdfcoding/pymassspec/badge.svg?branch=master\nbefore you submit a pull request.\n\nFor further information see the section `Contributing to PyMassSpec`_\n\nLicense\n=========\nPyMassSpec is Free and Open Source software released under the `GNU General Public License version 2 `__.\n\n\nIssues\n========\n\nIf you encounter any problems, please `file an issue`_ along with a\ndetailed description.\n\n\n.. _`documentation`: https://pymassspec.readthedocs.io\n.. _`Contributing to PyMassSpec`: https://pymassspec.readthedocs.io/en/master/Contributing/Contributing.html\n.. _`pytest`: https://pytest.org/\n.. _`file an issue`: https://github.com/domdfcoding/pymassspec/issues\n.. _Python: https://www.python.org/\n.. _GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html\n\n\n.. _pyms_demo: https://pymassspec.readthedocs.io/en/master/pyms-demo/introduction.html#pyms-demo\n.. _datafiles: https://pymassspec.readthedocs.io/en/master/pyms-demo/data-files.html\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/domdfcoding/PyMassSpec", "keywords": "", "license": "GPL2", "maintainer": "", "maintainer_email": "", "name": "PyMassSpec", "package_url": "https://pypi.org/project/PyMassSpec/", "platform": "", "project_url": "https://pypi.org/project/PyMassSpec/", "project_urls": { "Homepage": "https://github.com/domdfcoding/PyMassSpec" }, "release_url": "https://pypi.org/project/PyMassSpec/2.2.3/", "requires_dist": [ "numpy (>=1.16.2)", "scipy (>=1.2.1)", "pymzml (>=2.2.1)", "matplotlib (>=3.0.2)", "openpyxl (>=2.6.2)", "netCDF4 (>=1.5.0)", "biopython (>=1.74)", "deprecation (>=2.0.6)" ], "requires_python": "", "summary": "Python Toolkit for Mass Spectrometry", "version": "2.2.3" }, "last_serial": 5982063, "releases": { "2.1.0": [ { "comment_text": "", "digests": { "md5": "41ff08e2acf22ecaec1256081b8a298c", "sha256": "70b66ba06e6ba6fb280f6883f1000ae915989ce379ff34a14d250ce70700b1e2" }, "downloads": -1, "filename": "PyMassSpec-2.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "41ff08e2acf22ecaec1256081b8a298c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 102878, "upload_time": "2019-04-12T15:23:04", "url": "https://files.pythonhosted.org/packages/00/c6/4e6f32af7a5f97d190db407556fb8e8a1532f8f3579cd8a0da9ccbde377c/PyMassSpec-2.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2eb4cabef3f97bb932474692c6b0b44d", "sha256": "f3b4e6ef51af03577392ba21f4e1251374577ac9e908ddef06ee4d58b2949ef2" }, "downloads": -1, "filename": "PyMassSpec-2.1.0.tar.gz", "has_sig": false, "md5_digest": "2eb4cabef3f97bb932474692c6b0b44d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 56183, "upload_time": "2019-04-12T15:23:07", "url": "https://files.pythonhosted.org/packages/ec/55/eff4746032f4fe91dfacabb66ad74681726e2ac403165564a4d98652cd37/PyMassSpec-2.1.0.tar.gz" } ], "2.2.3": [ { "comment_text": "", "digests": { "md5": "1e1f5e94d91786b85d7f2eee98805aa1", "sha256": "210f093f22d491bf70764778f05135d11ce6c9a9d1607c0c0c33f67af428230c" }, "downloads": -1, "filename": "PyMassSpec-2.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "1e1f5e94d91786b85d7f2eee98805aa1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 147767, "upload_time": "2019-10-16T08:56:47", "url": "https://files.pythonhosted.org/packages/5c/27/915d27940bcbb4096581b7d7e8eee0efb1d8e7f6731d7ff88ed9675ba3ff/PyMassSpec-2.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4b4ad8fde31ae66fe0cbb1c9aa3bfb01", "sha256": "b137c3d0373139bbd7e499c9bd9f3731358a081ddb4134d38d3b1989ae44e080" }, "downloads": -1, "filename": "PyMassSpec-2.2.3.tar.gz", "has_sig": false, "md5_digest": "4b4ad8fde31ae66fe0cbb1c9aa3bfb01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 90054, "upload_time": "2019-10-16T08:56:49", "url": "https://files.pythonhosted.org/packages/f9/cd/3bd6b5304a5f0293b6c1cdbc9bb5913b274c394d7d7640c1ee5d3b1b2a57/PyMassSpec-2.2.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1e1f5e94d91786b85d7f2eee98805aa1", "sha256": "210f093f22d491bf70764778f05135d11ce6c9a9d1607c0c0c33f67af428230c" }, "downloads": -1, "filename": "PyMassSpec-2.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "1e1f5e94d91786b85d7f2eee98805aa1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 147767, "upload_time": "2019-10-16T08:56:47", "url": "https://files.pythonhosted.org/packages/5c/27/915d27940bcbb4096581b7d7e8eee0efb1d8e7f6731d7ff88ed9675ba3ff/PyMassSpec-2.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4b4ad8fde31ae66fe0cbb1c9aa3bfb01", "sha256": "b137c3d0373139bbd7e499c9bd9f3731358a081ddb4134d38d3b1989ae44e080" }, "downloads": -1, "filename": "PyMassSpec-2.2.3.tar.gz", "has_sig": false, "md5_digest": "4b4ad8fde31ae66fe0cbb1c9aa3bfb01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 90054, "upload_time": "2019-10-16T08:56:49", "url": "https://files.pythonhosted.org/packages/f9/cd/3bd6b5304a5f0293b6c1cdbc9bb5913b274c394d7d7640c1ee5d3b1b2a57/PyMassSpec-2.2.3.tar.gz" } ] }