#####################################
Time-of-flight spectrometer Simulator
#####################################
tof-simulator is a package to simulate the spectra from a Time-of-Flight mass spectrometer.
It has capabilities to analyze substances from convenient names and may be used as a python module in a script or interactively as a Graphical program.
****
Demo
****
- Start the GUI and calculate the spectra
.. image:: doc/images/demo1.gif
- Modify the TOF parameters and recalculate
.. image:: doc/images/demo2.gif
************
Installation
************
Install using pip, either system-wide (administrator rights are needed)
::
pip install tof-simulator-X.Y.tar.gz
or (usually preferred) for the current user:
::
pip install --user tof-simulator-X.Y.tar.gz
************
Dependencies
************
- In order to run the simulator programmatically:
- Only `Numpy <https://numpy.org>`_ is required.
- Optionally, `matplotlib <matplotlib.org>`_ is needed to use included capabilities for plotting.
- To use the GUI, the requirements are:
- `matplotlib <matplotlib.org>`_
- `PyGobject <https://pygobject.readthedocs.io/en/latest>`_.
Information on how to install PyGobject on different platforms may be found in
`the documentation <https://pygobject.readthedocs.io/en/latest/getting_started.html>`_
*********
Copyright
*********
Copyright (C) 2020 Juan Fiol
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see https://www.gnu.org/licenses/.
*************
Documentation
*************
Further information on installation, dependencies and use may be found in the `documentation <https://tof-simulator.readthedocs.io/en/latest/>`_.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Raw data
{
"_id": null,
"home_page": "https://github.com/fiolj/tof-simulator",
"name": "tof-simulator",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "simulation,mass-spectrometry,TOF",
"author": "Juan Fiol",
"author_email": "juanfiol@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/26/dd5686278b9764fd23e5606ae6b073b909c124536d6457593b446662dd31/tof-simulator-3.5.tar.gz",
"platform": null,
"description": "\n#####################################\nTime-of-flight spectrometer Simulator\n#####################################\n\ntof-simulator is a package to simulate the spectra from a Time-of-Flight mass spectrometer.\n\nIt has capabilities to analyze substances from convenient names and may be used as a python module in a script or interactively as a Graphical program.\n\n****\nDemo\n****\n\n- Start the GUI and calculate the spectra\n\n .. image:: doc/images/demo1.gif\n\n\n- Modify the TOF parameters and recalculate\n\n .. image:: doc/images/demo2.gif\n\n\n\n************\nInstallation\n************\n\nInstall using pip, either system-wide (administrator rights are needed)\n\n::\n\n pip install tof-simulator-X.Y.tar.gz\n\nor (usually preferred) for the current user:\n\n::\n\n pip install --user tof-simulator-X.Y.tar.gz\n\n\n************\nDependencies\n************\n\n- In order to run the simulator programmatically:\n\n - Only `Numpy <https://numpy.org>`_ is required.\n - Optionally, `matplotlib <matplotlib.org>`_ is needed to use included capabilities for plotting.\n\n- To use the GUI, the requirements are:\n\n - `matplotlib <matplotlib.org>`_\n\n - `PyGobject <https://pygobject.readthedocs.io/en/latest>`_.\n \n Information on how to install PyGobject on different platforms may be found in\n `the documentation <https://pygobject.readthedocs.io/en/latest/getting_started.html>`_\n\n\n*********\nCopyright\n*********\n\nCopyright (C) 2020 Juan Fiol\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see https://www.gnu.org/licenses/.\n\n\n\n*************\nDocumentation\n*************\n\nFurther information on installation, dependencies and use may be found in the `documentation <https://tof-simulator.readthedocs.io/en/latest/>`_.\n\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n",
"bugtrack_url": null,
"license": "",
"summary": "Time-of-Flight Mass spectrometry simulator",
"version": "3.5",
"split_keywords": [
"simulation",
"mass-spectrometry",
"tof"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da26dd5686278b9764fd23e5606ae6b073b909c124536d6457593b446662dd31",
"md5": "dac7d66e5e27a6735c626bcffd721e9f",
"sha256": "dbb53c497d1baca8297e749075a25603a9752e46b6397adc3844e2df6702f68d"
},
"downloads": -1,
"filename": "tof-simulator-3.5.tar.gz",
"has_sig": false,
"md5_digest": "dac7d66e5e27a6735c626bcffd721e9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 169855,
"upload_time": "2023-01-17T16:03:08",
"upload_time_iso_8601": "2023-01-17T16:03:08.030810Z",
"url": "https://files.pythonhosted.org/packages/da/26/dd5686278b9764fd23e5606ae6b073b909c124536d6457593b446662dd31/tof-simulator-3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 16:03:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fiolj",
"github_project": "tof-simulator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tof-simulator"
}
JSON
