| Name | NeutroSpecUI JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | A package for the analysis of Neutron X-ray Spectroscopy data |
| upload_time | 2025-02-05 13:13:17 |
| maintainer | None |
| docs_url | None |
| author | Mitra Nassermostofi, Luisa Haussner, Elina Lickes, Benedikt Bletz, Sebastian Braun |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) [2025] [Mitra Nassermostofi], [Elina Lickes], [Luisa Haussner], [Benedikt Bletz], [Sebastian Braun], [Joshua Reed]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
neutron
x-ray
spectroscopy
analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NeutroSpecUI
[](https://github.com/psf/black)
## Description
NeutroSpecUI is a user-friendly tool for neutron reflectivity data analysis, transforming a traditionally time-consuming and complex manual fitting process into an efficient and intuitive experience.
## Table of Contents
- [NeutroSpecUI](#neutrospecui)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
## Installation
### Prerequisites
- Python 3.10 or higher
- pip
### Steps
1. Install NeutroSpecUI using pip:
```sh
pip install NeutroSpecUI
```
## Usage
To use NeutroSpecUI, you can run the application from the command line.
```sh
python -m NeutroSpecUI
```
For more information on how to use the application, please refer to the [User Guide](https://github.com/Aseraphyss/NeutroSpecUI/wiki/Usage).
## Features
- Intuitive GUI for parameter input and data visualization
- Real-time updates with immediate visual feedback
- Flexible model fitting with support for custom models
- Data management capabilities to save and load configurations
- Cross-platform compatibility (Windows, Mac, Linux)
## Contributing
We welcome contributions and feedback from collaborators and researchers. Please feel free to open issues or submit pull requests to help improve the project. Nevertheless, please note that this project is part of a university course, and we stop maintaining it after the course ends in 2025.
For more information you can visit the Wiki [Contributing](https://github.com/Aseraphyss/NeutroSpecUI/wiki/Contributing).
Raw data
{
"_id": null,
"home_page": null,
"name": "NeutroSpecUI",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "neutron, x-ray, spectroscopy, analysis",
"author": "Mitra Nassermostofi, Luisa Haussner, Elina Lickes, Benedikt Bletz, Sebastian Braun",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/db/33/a5e2de197ab36db7777085f941300617f3483516c26f0dc8828269fedce3/neutrospecui-1.0.1.tar.gz",
"platform": null,
"description": "# NeutroSpecUI\n\n\n\n[](https://github.com/psf/black)\n\n## Description\n\nNeutroSpecUI is a user-friendly tool for neutron reflectivity data analysis, transforming a traditionally time-consuming and complex manual fitting process into an efficient and intuitive experience.\n\n## Table of Contents\n\n- [NeutroSpecUI](#neutrospecui)\n - [Description](#description)\n - [Table of Contents](#table-of-contents)\n - [Installation](#installation)\n - [Prerequisites](#prerequisites)\n - [Steps](#steps)\n - [Usage](#usage)\n - [Features](#features)\n - [Contributing](#contributing)\n\n## Installation\n\n### Prerequisites\n\n- Python 3.10 or higher\n- pip\n\n### Steps\n\n1. Install NeutroSpecUI using pip:\n\n```sh\npip install NeutroSpecUI\n```\n\n## Usage\n\nTo use NeutroSpecUI, you can run the application from the command line.\n\n```sh\npython -m NeutroSpecUI\n```\n\nFor more information on how to use the application, please refer to the [User Guide](https://github.com/Aseraphyss/NeutroSpecUI/wiki/Usage).\n\n## Features\n\n- Intuitive GUI for parameter input and data visualization\n- Real-time updates with immediate visual feedback\n- Flexible model fitting with support for custom models\n- Data management capabilities to save and load configurations\n- Cross-platform compatibility (Windows, Mac, Linux)\n\n## Contributing\n\nWe welcome contributions and feedback from collaborators and researchers. Please feel free to open issues or submit pull requests to help improve the project. Nevertheless, please note that this project is part of a university course, and we stop maintaining it after the course ends in 2025.\n\nFor more information you can visit the Wiki [Contributing](https://github.com/Aseraphyss/NeutroSpecUI/wiki/Contributing).\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) [2025] [Mitra Nassermostofi], [Elina Lickes], [Luisa Haussner], [Benedikt Bletz], [Sebastian Braun], [Joshua Reed]\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "A package for the analysis of Neutron X-ray Spectroscopy data",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/Aseraphyss/NeutroSpecUI",
"Issues": "https://github.com/Aseraphyss/NeutroSpecUI/issues"
},
"split_keywords": [
"neutron",
" x-ray",
" spectroscopy",
" analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ac2dcc1a65083a6ff3b8e57d16b8a53729fe1014c88710e9ff18ca2ccb2cd04f",
"md5": "1a8ef15b10928d80c32ac73fba4d6124",
"sha256": "19616dad4b249172d88679bc0b3420700374d05c53d8a7ed3675adbf934da71f"
},
"downloads": -1,
"filename": "NeutroSpecUI-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a8ef15b10928d80c32ac73fba4d6124",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 26772,
"upload_time": "2025-02-05T13:13:15",
"upload_time_iso_8601": "2025-02-05T13:13:15.671713Z",
"url": "https://files.pythonhosted.org/packages/ac/2d/cc1a65083a6ff3b8e57d16b8a53729fe1014c88710e9ff18ca2ccb2cd04f/NeutroSpecUI-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "db33a5e2de197ab36db7777085f941300617f3483516c26f0dc8828269fedce3",
"md5": "5c2a8e08c149998a7082c864e57017f2",
"sha256": "b30c7fa9a1f473ae6367e812cb1fed63c9616ddc85fa538dfbc20c59e24826ee"
},
"downloads": -1,
"filename": "neutrospecui-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5c2a8e08c149998a7082c864e57017f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 22709,
"upload_time": "2025-02-05T13:13:17",
"upload_time_iso_8601": "2025-02-05T13:13:17.652867Z",
"url": "https://files.pythonhosted.org/packages/db/33/a5e2de197ab36db7777085f941300617f3483516c26f0dc8828269fedce3/neutrospecui-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 13:13:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Aseraphyss",
"github_project": "NeutroSpecUI",
"github_not_found": true,
"lcname": "neutrospecui"
}
