Crispy is a modern graphical user interface to calculate core-level spectra
using the semi-empirical multiplet approaches implemented in `Quanty
<http://quanty.org>`_. The application provides tools to generate input files,
submit calculations, and plot the resulting spectra.
|release| |downloads| |DOI| |license|
.. |downloads| image:: https://img.shields.io/github/downloads/mretegan/crispy/total.svg
:target: https://github.com/mretegan/crispy/releases
.. |release| image:: https://img.shields.io/github/release/mretegan/crispy.svg
:target: https://github.com/mretegan/crispy/releases
.. |DOI| image:: https://zenodo.org/badge/doi/10.5281/zenodo.1008184.svg
:target: https://dx.doi.org/10.5281/zenodo.1008184
.. |license| image:: https://img.shields.io/github/license/mretegan/crispy.svg
:target: https://github.com/mretegan/crispy/blob/master/LICENSE.txt
.. first-marker
.. image:: https://raw.githubusercontent.com/mretegan/crispy/main/docs/assets/main_window.png
.. second-marker
Installation
============
Latest Release
--------------
**Using the Package Installers**
The easiest way to install Crispy on Windows and macOS operating systems is to
use the installers provided on the project's `downloads page
<http://www.esrf.eu/computing/scientific/crispy/downloads.html>`_.
**Using pip**
Pip is the package manager for Python, and before you can use it to install
Crispy, you have to make sure that you have a working Python distribution. On
macOS and Windows, you can install Python using the `official installers
<https://www.python.org/downloads>`_. In particular, for Windows, you should
install the 64-bit version of Python and make sure that you select to add
Python to the system's PATH during the installation.
.. code:: sh
python3 -m pip install crispy
After the installation finishes, you should be able to start the program from
the command line:
.. code:: sh
crispy
If you have problems running the previous command, it is probably due to not
having your PATH environment variable set correctly.
.. code:: sh
export PATH=$HOME/.local/bin:$PATH
Development Version
-------------------
**Using pip**
Assuming that you have a working Python distribution (version 3.7 or greater),
you can easily install the development version of Crispy using pip:
.. code:: sh
python3 -m pip install https://github.com/mretegan/crispy/tarball/main
To update the development version of Crispy, you can use the following command:
.. code:: sh
python3 -m pip install --ignore-installed https://github.com/mretegan/crispy/tarball/main
.. third-marker
Usage
=====
.. forth-marker
Crispy should be easy to find and launch if you have used the installers. For
the installation using pip follow the instructions from the **Installation**
section.
.. fifth-marker
Citation
========
Crispy is a scientific software. If you use it for a scientific publication,
please cite the following reference (change the version number if required)::
@misc{retegan_crispy,
author = {Retegan, Marius},
title = {Crispy: v0.8.0},
year = {2024},
doi = {10.5281/zenodo.1008184},
url = {https://dx.doi.org/10.5281/zenodo.1008184}
}
.. sixth-marker
License
=======
The source code of Crispy is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": null,
"name": "crispy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "gui, science, simulation, spectroscopy, synchrotron",
"author": null,
"author_email": "Marius Retegan <marius.retegan@esrf.fr>",
"download_url": "https://files.pythonhosted.org/packages/9e/5a/c6932024efa1a1c8a19c16a04811db0f70ad777cc45d2c1065337e8c78e2/crispy-0.8.0.tar.gz",
"platform": null,
"description": "Crispy is a modern graphical user interface to calculate core-level spectra\nusing the semi-empirical multiplet approaches implemented in `Quanty\n<http://quanty.org>`_. The application provides tools to generate input files,\nsubmit calculations, and plot the resulting spectra.\n\n|release| |downloads| |DOI| |license|\n\n.. |downloads| image:: https://img.shields.io/github/downloads/mretegan/crispy/total.svg\n :target: https://github.com/mretegan/crispy/releases\n\n.. |release| image:: https://img.shields.io/github/release/mretegan/crispy.svg\n :target: https://github.com/mretegan/crispy/releases\n\n.. |DOI| image:: https://zenodo.org/badge/doi/10.5281/zenodo.1008184.svg\n :target: https://dx.doi.org/10.5281/zenodo.1008184\n\n.. |license| image:: https://img.shields.io/github/license/mretegan/crispy.svg\n :target: https://github.com/mretegan/crispy/blob/master/LICENSE.txt\n\n.. first-marker\n\n.. image:: https://raw.githubusercontent.com/mretegan/crispy/main/docs/assets/main_window.png\n\n.. second-marker\n\nInstallation\n============\n\nLatest Release\n--------------\n\n**Using the Package Installers**\n\nThe easiest way to install Crispy on Windows and macOS operating systems is to\nuse the installers provided on the project's `downloads page\n<http://www.esrf.eu/computing/scientific/crispy/downloads.html>`_.\n\n**Using pip**\n\nPip is the package manager for Python, and before you can use it to install\nCrispy, you have to make sure that you have a working Python distribution. On\nmacOS and Windows, you can install Python using the `official installers\n<https://www.python.org/downloads>`_. In particular, for Windows, you should\ninstall the 64-bit version of Python and make sure that you select to add\nPython to the system's PATH during the installation.\n\n.. code:: sh\n\n python3 -m pip install crispy\n\nAfter the installation finishes, you should be able to start the program from\nthe command line:\n\n.. code:: sh\n\n crispy\n\nIf you have problems running the previous command, it is probably due to not\nhaving your PATH environment variable set correctly.\n\n.. code:: sh\n\n export PATH=$HOME/.local/bin:$PATH\n\n\nDevelopment Version\n-------------------\n\n**Using pip**\n\nAssuming that you have a working Python distribution (version 3.7 or greater),\nyou can easily install the development version of Crispy using pip:\n\n.. code:: sh\n\n python3 -m pip install https://github.com/mretegan/crispy/tarball/main\n\nTo update the development version of Crispy, you can use the following command:\n\n.. code:: sh\n\n python3 -m pip install --ignore-installed https://github.com/mretegan/crispy/tarball/main\n\n.. third-marker\n\nUsage\n=====\n\n.. forth-marker\n\nCrispy should be easy to find and launch if you have used the installers. For\nthe installation using pip follow the instructions from the **Installation**\nsection.\n\n.. fifth-marker\n\nCitation\n========\nCrispy is a scientific software. If you use it for a scientific publication,\nplease cite the following reference (change the version number if required)::\n\n @misc{retegan_crispy,\n author = {Retegan, Marius},\n title = {Crispy: v0.8.0},\n year = {2024},\n doi = {10.5281/zenodo.1008184},\n url = {https://dx.doi.org/10.5281/zenodo.1008184}\n }\n\n.. sixth-marker\n\nLicense\n=======\nThe source code of Crispy is licensed under the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Core-Level Spectroscopy Simulations in Python",
"version": "0.8.0",
"project_urls": {
"Changelog": "https://github.com/mretegan/crispy/blob/main/CHANGELOG.rst",
"Documentation": "https://www.esrf.fr/computing/scientific/crispy",
"Downloads": "https://github.com/mretegan/crispy/releases",
"Homepage": "https://github.com/mretegan/crispy",
"Source": "https://github.com/mretegan/crispy",
"Tracker": "https://github.com/mretegan/crispy/issues"
},
"split_keywords": [
"gui",
" science",
" simulation",
" spectroscopy",
" synchrotron"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ae3d33155e283a6aba48edaacd59493d820dfb2d74917e08e0b21d830b51d75",
"md5": "c2e84fdbee5278e00fd3724c2e946818",
"sha256": "2c2a2ec44e54467fd24417a0b385d62db14a643362e64599a823e4fb66480cdb"
},
"downloads": -1,
"filename": "crispy-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c2e84fdbee5278e00fd3724c2e946818",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32318067,
"upload_time": "2024-09-26T19:37:09",
"upload_time_iso_8601": "2024-09-26T19:37:09.428548Z",
"url": "https://files.pythonhosted.org/packages/1a/e3/d33155e283a6aba48edaacd59493d820dfb2d74917e08e0b21d830b51d75/crispy-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e5ac6932024efa1a1c8a19c16a04811db0f70ad777cc45d2c1065337e8c78e2",
"md5": "a0bfaee0307f857451be89889ead4afd",
"sha256": "3330e808cfb536dfa85c47e61a32f39982e854c1086bea849adef38a0d132d5c"
},
"downloads": -1,
"filename": "crispy-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "a0bfaee0307f857451be89889ead4afd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31106901,
"upload_time": "2024-09-26T19:45:06",
"upload_time_iso_8601": "2024-09-26T19:45:06.635290Z",
"url": "https://files.pythonhosted.org/packages/9e/5a/c6932024efa1a1c8a19c16a04811db0f70ad777cc45d2c1065337e8c78e2/crispy-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 19:45:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mretegan",
"github_project": "crispy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "crispy"
}
JSON
