# prompt
Prompt: Probability-Conserved Cross Section Biasing Monte Carlo Particle Transport System.
Introduction of system can be found at [arXiv](https://arxiv.org/abs/2304.06226).
## Installing on Linux(Ubuntu) from source
To build Prompt, several prerequisites are needed.
```
sudo apt install g++ cmake python3-dev python3-pip python3-venv
```
Clone the source and compile it as
```
git clone https://gitlab.com/cinema-developers/prompt.git
cd prompt
. env.sh
cimbuild
```
## Installing on Linux with pip
```
pip install neutron-cinema
```
## Runing Prompt simulations
After installation, GDML formatted simulation input files can be launched by Prompt as
```
prompt [-g file] [-s seed] [-n number] [-v]
```
| Option | Defult | Description |
|:-----:|:--------:|:------|
| -g | | Set GDML input file. |
| -s | 4096 | Set the seed for the random generator |
| -n | 100 | Set the number of primary neutron events |
| -v | | The flag to activate the visualisation |
Example of visualising the geometry defined in the total_scattering.gdml:
```
prompt -g total_scattering.gdml -v
```
The simulation will produce histogroms in the MCPL format only in the production run, if any scorers are specified. To run the simulation with 1e6 neutrons
```
prompt -g total_scattering.gdml -n 1e6
```
After the execution, seven histogrom files and accosiated python analysis template scripts will be generated. The reults can be plotted as
```
python ScorerDeltaMomentum_PofQ_HW_view.py
```
There are many input examples are available in the gdml sub-directory.
<h3 align="left">Connect with us:</h3>
<p align="left"><a href="mailto:cinema-users@outlook.com">cinema-users@outlook.com</a>
</p>
Raw data
{
"_id": null,
"home_page": "",
"name": "neutron-cinema",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "NCyrstal,Neutron Scattering,Spectroscopy",
"author": "Xiao-Xiao Cai, Ming Tang, Zi-Yi Pan, Ni Yang",
"author_email": "cinema-users@outlook.com",
"download_url": "",
"platform": null,
"description": "# prompt\n\nPrompt: Probability-Conserved Cross Section Biasing Monte Carlo Particle Transport System. \n\nIntroduction of system can be found at [arXiv](https://arxiv.org/abs/2304.06226).\n\n## Installing on Linux(Ubuntu) from source\n\nTo build Prompt, several prerequisites are needed.\n```\nsudo apt install g++ cmake python3-dev python3-pip python3-venv\n```\n\nClone the source and compile it as\n\n```\ngit clone https://gitlab.com/cinema-developers/prompt.git\ncd prompt\n. env.sh\ncimbuild\n```\n\n## Installing on Linux with pip\n\n```\npip install neutron-cinema\n```\n\n\n## Runing Prompt simulations\n\nAfter installation, GDML formatted simulation input files can be launched by Prompt as \n\n\n```\nprompt [-g file] [-s seed] [-n number] [-v]\n```\n\n| Option | Defult | Description |\n|:-----:|:--------:|:------|\n| -g | | Set GDML input file. | \n| -s | 4096 | Set the seed for the random generator |\n| -n | 100 | Set the number of primary neutron events |\n| -v | | The flag to activate the visualisation |\n\nExample of visualising the geometry defined in the total_scattering.gdml:\n```\nprompt -g total_scattering.gdml -v\n```\n\nThe simulation will produce histogroms in the MCPL format only in the production run, if any scorers are specified. To run the simulation with 1e6 neutrons\n```\nprompt -g total_scattering.gdml -n 1e6\n```\n\nAfter the execution, seven histogrom files and accosiated python analysis template scripts will be generated. The reults can be plotted as \n```\npython ScorerDeltaMomentum_PofQ_HW_view.py\n```\n\nThere are many input examples are available in the gdml sub-directory. \n\n\n<h3 align=\"left\">Connect with us:</h3>\n<p align=\"left\"><a href=\"mailto:cinema-users@outlook.com\">cinema-users@outlook.com</a>\n</p>\n",
"bugtrack_url": null,
"license": "",
"summary": "China Spallation Neutron Source Monte Carlo System",
"version": "1.0.0",
"project_urls": {
"repository": "https://gitlab.com/cinema-developers/prompt.git"
},
"split_keywords": [
"ncyrstal",
"neutron scattering",
"spectroscopy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "034621bfe905a3307f767b7f6ffc28b1e23414019f68b6864fbd67a52de264b6",
"md5": "1de32ba160c70de26c3ebfbd735bbc4f",
"sha256": "5d85342f0c379c994af90621288f9327e172314f6d586dc8e823820094757b07"
},
"downloads": -1,
"filename": "neutron_cinema-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "1de32ba160c70de26c3ebfbd735bbc4f",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 11157087,
"upload_time": "2023-12-08T10:09:45",
"upload_time_iso_8601": "2023-12-08T10:09:45.082313Z",
"url": "https://files.pythonhosted.org/packages/03/46/21bfe905a3307f767b7f6ffc28b1e23414019f68b6864fbd67a52de264b6/neutron_cinema-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f092dfff144f6d84ec911496abe073c80a62f56cde081b4542a0adb494c08755",
"md5": "bb0281ec1bf0945d8794059fbc7d9988",
"sha256": "a7173e19721712108c27d52a3f0cb02c4fe96aafabff6d0c97011c7ff1a43898"
},
"downloads": -1,
"filename": "neutron_cinema-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "bb0281ec1bf0945d8794059fbc7d9988",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 11157088,
"upload_time": "2023-12-08T10:09:53",
"upload_time_iso_8601": "2023-12-08T10:09:53.252534Z",
"url": "https://files.pythonhosted.org/packages/f0/92/dfff144f6d84ec911496abe073c80a62f56cde081b4542a0adb494c08755/neutron_cinema-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c42ebbeafa69e289a04d297eb773aca557ecebb0a752a45fcaef0d2322ff107",
"md5": "5687e5b549993e7599fb5aea51f2db54",
"sha256": "919e619a087449bbe7a0fff200d1f3bcaf0eae25d21d179d31c6a89e13c78280"
},
"downloads": -1,
"filename": "neutron_cinema-1.0.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "5687e5b549993e7599fb5aea51f2db54",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.7",
"size": 11157087,
"upload_time": "2023-12-08T10:09:58",
"upload_time_iso_8601": "2023-12-08T10:09:58.440887Z",
"url": "https://files.pythonhosted.org/packages/8c/42/ebbeafa69e289a04d297eb773aca557ecebb0a752a45fcaef0d2322ff107/neutron_cinema-1.0.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b74b73c4679885a5f4d6803ad1180a15e08ffbc819451a49f24b624816bc9ef",
"md5": "c48a06195c4a7f29e79b4f548f15ddc8",
"sha256": "15711b19a4ba17967d560c20b9f2e0c448753a7f5922fbe3a60966b936cc5ab7"
},
"downloads": -1,
"filename": "neutron_cinema-1.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "c48a06195c4a7f29e79b4f548f15ddc8",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 11157090,
"upload_time": "2023-12-08T10:10:05",
"upload_time_iso_8601": "2023-12-08T10:10:05.051234Z",
"url": "https://files.pythonhosted.org/packages/6b/74/b73c4679885a5f4d6803ad1180a15e08ffbc819451a49f24b624816bc9ef/neutron_cinema-1.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "525ebce57f0f804641a10ea932a0ea5b19487a8758468b7ec678249e8d871378",
"md5": "5497c2a8c282977b6b3426d96a4c7ed8",
"sha256": "9a5b7abb189b06c700e34e6417fba41a7817c36008201b0ce24920709a67d22c"
},
"downloads": -1,
"filename": "neutron_cinema-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "5497c2a8c282977b6b3426d96a4c7ed8",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 11157085,
"upload_time": "2023-12-08T10:10:09",
"upload_time_iso_8601": "2023-12-08T10:10:09.774846Z",
"url": "https://files.pythonhosted.org/packages/52/5e/bce57f0f804641a10ea932a0ea5b19487a8758468b7ec678249e8d871378/neutron_cinema-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e5e789e8f96607a015375fce20865e17fa6164a05f2a7d25e0dacf7d2932173",
"md5": "6009dcd39995fde9040c0e8519216001",
"sha256": "43538481477a4217c88eaa28c3049ee61ae5037d12a5612334c17896792d10a4"
},
"downloads": -1,
"filename": "neutron_cinema-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "6009dcd39995fde9040c0e8519216001",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 11157085,
"upload_time": "2023-12-08T10:10:14",
"upload_time_iso_8601": "2023-12-08T10:10:14.104615Z",
"url": "https://files.pythonhosted.org/packages/1e/5e/789e8f96607a015375fce20865e17fa6164a05f2a7d25e0dacf7d2932173/neutron_cinema-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 10:09:45",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "cinema-developers",
"gitlab_project": "prompt",
"lcname": "neutron-cinema"
}
JSON