| Name | xframe JSON |
| Version |
0.9.8
JSON |
| download |
| home_page | |
| Summary | A framework for scientific algorithms targeting X-ray scattering |
| upload_time | 2023-09-26 14:11:25 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
scientific computing
xray
fxs
physics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/European-XFEL/xframe/releases)
[](https://xframe-fxs.readthedocs.io/en/latest/)
[](https://xframe-fxs.readthedocs.io/en/latest/)
# Introduction
The main objective of __xFrame__ is to provide an easy and flexible framwork that handles details such as
- Data storage / File access
- Settings management
- Multiprocessing
- GPU access
Allowing users to focus on the "scientific" part of their algorithm.
*xFrame* has been created during our quest of writing a toolkit for fluctuation X-ray scattering.
To install *xFrame* simply call
```
pip install xframe
# For the fluctuation scattering toolkit use the following command instead (see next section)
pip install 'xframe[fxs]'
```
For more information and tutorials visit the documentaiton at [xframe-fxs.readthedocs.io](https://xframe-fxs.readthedocs.io)
# Fluctuation X-Ray Scattering Toolkit [fxs]
The project __fxs__ comes bundled with *xFrame* and provides a workflow for 3D structure determination from fluctuation X-ray scattering data.
__Note: No data is required to perform test reconstructions__, further information as well as tutorials can be found at [xframe-fxs.readthedocs.io/en/latest/fxs](https://xframe-fxs.readthedocs.io/en/latest/fxs)
To install *xFrame* together with the dependencies needed by *fxs* simply call
```
pip install 'xframe[fxs]'
```
please make sure that the following libraries are installed on your system before calling `pip install`
- [GNU Scientific Library](https://www.gnu.org/software/gsl/)
- [OpenCL](https://www.khronos.org/opencl/)
# Citation
If you find this piece of software usefull for your scientific project consider citing the paper
Still in review ... :)
Raw data
{
"_id": null,
"home_page": "",
"name": "xframe",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "scientific computing,xray,FXS,physics",
"author": "",
"author_email": "Tim Berberich <tim.berberich@xfel.eu>",
"download_url": "https://files.pythonhosted.org/packages/96/52/97c6bd85ac306c0014b3610e1f157b49bbbc421912fb4ac96329e35a189b/xframe-0.9.8.tar.gz",
"platform": null,
"description": "![](https://raw.githubusercontent.com/European-XFEL/xframe/main/docs/images/xFrame_logo_title.svg \"xFrame logo\")\n[](https://github.com/European-XFEL/xframe/releases)\n\n[](https://xframe-fxs.readthedocs.io/en/latest/)\n[](https://xframe-fxs.readthedocs.io/en/latest/)\n\n# Introduction\nThe main objective of __xFrame__ is to provide an easy and flexible framwork that handles details such as\n- Data storage / File access\n- Settings management\n- Multiprocessing\n- GPU access\n\nAllowing users to focus on the \"scientific\" part of their algorithm. \n*xFrame* has been created during our quest of writing a toolkit for fluctuation X-ray scattering.\nTo install *xFrame* simply call\n```\npip install xframe\n# For the fluctuation scattering toolkit use the following command instead (see next section)\npip install 'xframe[fxs]'\n```\nFor more information and tutorials visit the documentaiton at [xframe-fxs.readthedocs.io](https://xframe-fxs.readthedocs.io)\n\n# Fluctuation X-Ray Scattering Toolkit [fxs]\nThe project __fxs__ comes bundled with *xFrame* and provides a workflow for 3D structure determination from fluctuation X-ray scattering data. \n\n__Note: No data is required to perform test reconstructions__, further information as well as tutorials can be found at [xframe-fxs.readthedocs.io/en/latest/fxs](https://xframe-fxs.readthedocs.io/en/latest/fxs)\n\nTo install *xFrame* together with the dependencies needed by *fxs* simply call\n```\npip install 'xframe[fxs]'\n```\nplease make sure that the following libraries are installed on your system before calling `pip install` \n- [GNU Scientific Library](https://www.gnu.org/software/gsl/)\n- [OpenCL](https://www.khronos.org/opencl/)\n\n\n# Citation\nIf you find this piece of software usefull for your scientific project consider citing the paper \nStill in review ... :)\n",
"bugtrack_url": null,
"license": "",
"summary": "A framework for scientific algorithms targeting X-ray scattering",
"version": "0.9.8",
"project_urls": {
"Documentation": "https://xframe-fxs.readthedocs.io",
"Homepage": "https://github.com/European-XFEL/xFrame"
},
"split_keywords": [
"scientific computing",
"xray",
"fxs",
"physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "830fbc0763429e11e34f01486b99709d571667581f21933ced6aba071cde0082",
"md5": "d6c8c18ca14ca669b153080f41887795",
"sha256": "3bca2de9a12b6b4c1443ab33ee669779ce1160a3522143eb2955e2375065db1e"
},
"downloads": -1,
"filename": "xframe-0.9.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6c8c18ca14ca669b153080f41887795",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 769118,
"upload_time": "2023-09-26T14:11:07",
"upload_time_iso_8601": "2023-09-26T14:11:07.636810Z",
"url": "https://files.pythonhosted.org/packages/83/0f/bc0763429e11e34f01486b99709d571667581f21933ced6aba071cde0082/xframe-0.9.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "965297c6bd85ac306c0014b3610e1f157b49bbbc421912fb4ac96329e35a189b",
"md5": "41ed2e469c87a09403e8ac00c355b304",
"sha256": "d05f1ebae824b66f6296ed3b4192afeae45ed8461ba61549ba7cf5d2750e5ebe"
},
"downloads": -1,
"filename": "xframe-0.9.8.tar.gz",
"has_sig": false,
"md5_digest": "41ed2e469c87a09403e8ac00c355b304",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16602698,
"upload_time": "2023-09-26T14:11:25",
"upload_time_iso_8601": "2023-09-26T14:11:25.103082Z",
"url": "https://files.pythonhosted.org/packages/96/52/97c6bd85ac306c0014b3610e1f157b49bbbc421912fb4ac96329e35a189b/xframe-0.9.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 14:11:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "European-XFEL",
"github_project": "xFrame",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "xframe"
}
