| Name | openmc-data JSON |
| Version |
2.2.8
JSON |
| download |
| home_page | |
| Summary | A Python package containing a collection of scripts for producing and downloading data for OpenMC |
| upload_time | 2024-02-22 17:59:52 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) 2019-2022 UChicago Argonne LLC and contributors 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 |
openmc
nuclear
data
download
process
cross
section
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/shimwell/data/actions/workflows/test_urls.yml)
[](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_package.yml)
[](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_processing.yml)
# OpenMC Data Scripts
This repository contains a collection of scripts for generating HDF5 data
libraries and xml chain files that can be used with OpenMC. Some of these
scripts convert existing ACE libraries (such as those produced by LANL) whereas
generate scripts use NJOY to process ENDF files directly.
Another source of data libraries for OpenMC is the [Windowed Multipole Library](https://github.com/mit-crpg/WMP_Library) repository which enables on-the-fly Doppler broadening to an arbitrary temperature.
# Prerequisites
You should have already installed OpenMC, see the [docs](https://docs.openmc.org/en/stable/quickinstall.html) for installation instructions.
# Installation
Currently the package can be installed from this temporary repository.
```bash
pip install openmc_data
```
# Usage
Once installed several scripts are available in your terminal that are able to
download and process nuclear data.
The scripts accept input arguments, to find out the input arguments available
for a particular script run the script name with ```--help``` after the name.
For example:
```convert_endf --help```
Some scripts (mainly the generate scripts) require NJOY to be installed and
added to your path.
A few categories of scripts are available:
<ul>
<li>Scripts that produce h5 cross section files:</li>
<ul>
<li>Convert ACE files to h5 files</li>
<li>Generate h5 file from ENDF files</li>
<li>Download h5 files</li>
</ul>
<li>Scripts that produce xml chain files:</li>
<ul>
<li>Generate xml chain files from ENDF files:</li>
<li>Download xml chain files:</li>
</ul>
<li>Other scripts that don't fall into either category.</li>
</ul>
## Produce Cross Section Files
### Convert cross sections
| Script name | Library | Release | Processed by |
|-|-|-|-|
|convert_mcnp70 | ENDF/B | VII.0 | LANL |
|convert_mcnp71 | ENDF/B | VII.1 | LANL |
|convert_endf | ENDF/B | VII.1 | NNDC |
|convert_lib80x | ENDF/B | VIII.0 | LANL |
|convert_fendl | FENDL | 3.2b<br>3.2a<br>3.2<br>3.1d<br>3.1a<br>3.1<br>3.0<br>2.1 |
|convert_jeff32 | JEFF | 3.2 |
|convert_jeff33 | JEFF | 3.3 |
|convert_tendl | TENDL | 2015<br>2017<br>2019<br>2021 |
### Generate cross sections
| Script name | Library | Release | Processed by |
|-|-|-|-|
| generate_cendl | CENDL | 3.1<br>3.2 | |
| generate_endf | ENDF/B | VII.1<br>VIII.0 | NNDC |
| generate_fendl | FENDL | 3.2b<br>3.2a<br>3.2<br>3.1d<br>3.1a<br>3.0 | |
| generate_jendl | JENDL | 4.0<br>5.0 | |
### Download cross sections
| Script name | Library | Release | Processed by |
|-|-|-|-|
| download_endf | ENDF/B | VII.1<br>VIII.0 | NNDC |
| download_tendl | TENDL | 2019<br>2021 | |
<!-- | Script name | Library | Release | Processed by | Download available | Downloads ACE files and convert to HDF5 | Downloads ENDF files and convert to HDF5 | Convert local ACE files |
|-|-|-|-|-|-|-|-|
|generate_cendl| CENDL | 3.1<br>3.2 | | | | :heavy_check_mark: | |
|convert_mcnp70| ENDF/B | VII.0 | LANL | [openmc.org](https://anl.box.com/shared/static/t25g7g6v0emygu50lr2ych1cf6o7454b.xz) | | | :heavy_check_mark: |
|convert_mcnp71| ENDF/B | VII.1 | LANL | [openmc.org](https://anl.box.com/shared/static/d359skd2w6wrm86om2997a1bxgigc8pu.xz) | | | :heavy_check_mark: |
|generate_endf| ENDF/B | VII.1 | NNDC | [openmc.org](https://anl.box.com/shared/static/9igk353zpy8fn9ttvtrqgzvw1vtejoz6.xz) | | :heavy_check_mark: | |
|convert_endf| ENDF/B | VII.1 | NNDC | [openmc.org](https://anl.box.com/shared/static/9igk353zpy8fn9ttvtrqgzvw1vtejoz6.xz) | :heavy_check_mark: | :heavy_check_mark: | |
|convert_lib80x| ENDF/B | VIII.0 | LANL | [openmc.org](https://anl.box.com/shared/static/nd7p4jherolkx4b1rfaw5uqp58nxtstr.xz) | | | :heavy_check_mark: |
|generate_endf| ENDF/B | VIII.0 | NNDC | [openmc.org](https://anl.box.com/shared/static/uhbxlrx7hvxqw27psymfbhi7bx7s6u6a.xz) | | :heavy_check_mark: | |
|convert_fendl| FENDL | 2.1<br>3.0<br>3.1a<br>3.1d<br>3.2 | | [openmc.org 3.2](https://anl.box.com/shared/static/3cb7jetw7tmxaw6nvn77x6c578jnm2ey.xz) | :heavy_check_mark: | | |
|generate_jendl| JENDL | 4.0 | | | | :heavy_check_mark: | |
|convert_jeff32| JEFF | 3.2 | | [openmc.org](https://anl.box.com/shared/static/pb94oxriiipezysu7w4r2qdoufc2epxv.xz) | :heavy_check_mark: | | |
|convert_jeff33| JEFF | 3.3 | | [openmc.org](https://anl.box.com/shared/static/ddetxzp0gv1buk1ev67b8ynik7f268hw.xz) | :heavy_check_mark: | | |
|convert_tendl| TENDL | 2015<br>2017<br>2019<br>2021| | | :heavy_check_mark: | | | -->
## Produce Depletion Chain files
### Generate chain files
| Script name | Library | Release |
|-|-|-|
|generate_endf_chain | ENDF/B | VII.1<br>VIII.0 |
|generate_jeff_chain | JEFF | 3.3 |
|generate_serpent_fissq | | |
|generate_tendl_chain | TENDL | 2019<br>2021 |
|generate_endf71_chain_casl | ENDF/B | |
### Download chain files
| Script name | Library | Release | Branching options|
|-|-|-|-|
|download_endf_chain | ENDF/B | VII.1<br>VIII.0 | None<br>SFR<br>PWR
<!-- | Sctipt name | Library | Release | Download available | Download ENDF files and generates XML chain files |
|-|-|-|-|-|
|generate_endf71_chain_casl|ENDF/B|-|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:|
|generate_endf_chain|ENDF/B|-|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:|
|generate_serpent_fissq|-|-|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:|
|generate_tendl_chain|TENDL|2019<br>2021|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:| -->
## Other scripts
| Script name | Description |
|-|-|
| convert_tendl_rand | Download random TENDL libraries from PSI and convert it to a HDF5 library for use with OpenMC. Only certain nuclides are available from PSI. This script generates a cross_sections_tendl.xml file with random TENDL evaluations plus a standard library located in 'OPENMC_CROSS_SECTIONS' |
| sample_sandy | This scripts generates random (gaussian) evaluations of a nuclear data file following its covariance matrix using SANDY, and converts them to HDF5 for use in OpenMC. Script generates a cross_sections_sandy.xml file with the standard library plus the sampled evaluations. |
| make_compton | |
| make_stopping_powers | |
| add_branching_ratios | add branching ratios for n,gamma reactions to a preexisting chain files. |
| reduce_chain | |
| combine_libraries | Combines multiple cross_section.xml files into a single cross_section.xml. |
Raw data
{
"_id": null,
"home_page": "",
"name": "openmc-data",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "openmc,nuclear,data,download,process,cross,section",
"author": "",
"author_email": "Jonathan Shimwell <mail@jshimwell.com>",
"download_url": "https://files.pythonhosted.org/packages/55/48/492c06fc27506cae91b8eb4104aef39d63a495a2e09d125ab006da31920a/openmc_data-2.2.8.tar.gz",
"platform": null,
"description": "[](https://github.com/shimwell/data/actions/workflows/test_urls.yml)\n\n[](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_package.yml)\n\n[](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_processing.yml)\n\n\n# OpenMC Data Scripts\n\nThis repository contains a collection of scripts for generating HDF5 data\nlibraries and xml chain files that can be used with OpenMC. Some of these\nscripts convert existing ACE libraries (such as those produced by LANL) whereas\ngenerate scripts use NJOY to process ENDF files directly.\n\nAnother source of data libraries for OpenMC is the [Windowed Multipole Library](https://github.com/mit-crpg/WMP_Library) repository which enables on-the-fly Doppler broadening to an arbitrary temperature.\n\n# Prerequisites\n\nYou should have already installed OpenMC, see the [docs](https://docs.openmc.org/en/stable/quickinstall.html) for installation instructions.\n\n# Installation\n\nCurrently the package can be installed from this temporary repository.\n\n```bash\npip install openmc_data\n```\n\n# Usage\n\nOnce installed several scripts are available in your terminal that are able to\ndownload and process nuclear data.\n\nThe scripts accept input arguments, to find out the input arguments available\nfor a particular script run the script name with ```--help``` after the name.\nFor example:\n\n```convert_endf --help```\n\nSome scripts (mainly the generate scripts) require NJOY to be installed and\nadded to your path.\n\nA few categories of scripts are available:\n<ul>\n<li>Scripts that produce h5 cross section files:</li>\n<ul>\n <li>Convert ACE files to h5 files</li>\n <li>Generate h5 file from ENDF files</li>\n <li>Download h5 files</li>\n</ul>\n<li>Scripts that produce xml chain files:</li>\n<ul>\n <li>Generate xml chain files from ENDF files:</li>\n <li>Download xml chain files:</li>\n</ul>\n<li>Other scripts that don't fall into either category.</li>\n</ul>\n\n## Produce Cross Section Files\n\n### Convert cross sections\n\n| Script name | Library | Release | Processed by |\n|-|-|-|-|\n|convert_mcnp70 | ENDF/B | VII.0 | LANL |\n|convert_mcnp71 | ENDF/B | VII.1 | LANL |\n|convert_endf | ENDF/B | VII.1 | NNDC |\n|convert_lib80x | ENDF/B | VIII.0 | LANL |\n|convert_fendl | FENDL | 3.2b<br>3.2a<br>3.2<br>3.1d<br>3.1a<br>3.1<br>3.0<br>2.1 |\n|convert_jeff32 | JEFF | 3.2 |\n|convert_jeff33 | JEFF | 3.3 |\n|convert_tendl | TENDL | 2015<br>2017<br>2019<br>2021 |\n\n### Generate cross sections\n\n| Script name | Library | Release | Processed by |\n|-|-|-|-|\n| generate_cendl | CENDL | 3.1<br>3.2 | |\n| generate_endf | ENDF/B | VII.1<br>VIII.0 | NNDC |\n| generate_fendl | FENDL | 3.2b<br>3.2a<br>3.2<br>3.1d<br>3.1a<br>3.0 | |\n| generate_jendl | JENDL | 4.0<br>5.0 | |\n\n\n### Download cross sections\n\n| Script name | Library | Release | Processed by |\n|-|-|-|-|\n| download_endf | ENDF/B | VII.1<br>VIII.0 | NNDC |\n| download_tendl | TENDL | 2019<br>2021 | |\n\n<!-- | Script name | Library | Release | Processed by | Download available | Downloads ACE files and convert to HDF5 | Downloads ENDF files and convert to HDF5 | Convert local ACE files |\n|-|-|-|-|-|-|-|-|\n|generate_cendl| CENDL | 3.1<br>3.2 | | | | :heavy_check_mark: | |\n|convert_mcnp70| ENDF/B | VII.0 | LANL | [openmc.org](https://anl.box.com/shared/static/t25g7g6v0emygu50lr2ych1cf6o7454b.xz) | | | :heavy_check_mark: |\n|convert_mcnp71| ENDF/B | VII.1 | LANL | [openmc.org](https://anl.box.com/shared/static/d359skd2w6wrm86om2997a1bxgigc8pu.xz) | | | :heavy_check_mark: |\n|generate_endf| ENDF/B | VII.1 | NNDC | [openmc.org](https://anl.box.com/shared/static/9igk353zpy8fn9ttvtrqgzvw1vtejoz6.xz) | | :heavy_check_mark: | |\n|convert_endf| ENDF/B | VII.1 | NNDC | [openmc.org](https://anl.box.com/shared/static/9igk353zpy8fn9ttvtrqgzvw1vtejoz6.xz) | :heavy_check_mark: | :heavy_check_mark: | |\n|convert_lib80x| ENDF/B | VIII.0 | LANL | [openmc.org](https://anl.box.com/shared/static/nd7p4jherolkx4b1rfaw5uqp58nxtstr.xz) | | | :heavy_check_mark: |\n|generate_endf| ENDF/B | VIII.0 | NNDC | [openmc.org](https://anl.box.com/shared/static/uhbxlrx7hvxqw27psymfbhi7bx7s6u6a.xz) | | :heavy_check_mark: | |\n|convert_fendl| FENDL | 2.1<br>3.0<br>3.1a<br>3.1d<br>3.2 | | [openmc.org 3.2](https://anl.box.com/shared/static/3cb7jetw7tmxaw6nvn77x6c578jnm2ey.xz) | :heavy_check_mark: | | |\n|generate_jendl| JENDL | 4.0 | | | | :heavy_check_mark: | |\n|convert_jeff32| JEFF | 3.2 | | [openmc.org](https://anl.box.com/shared/static/pb94oxriiipezysu7w4r2qdoufc2epxv.xz) | :heavy_check_mark: | | |\n|convert_jeff33| JEFF | 3.3 | | [openmc.org](https://anl.box.com/shared/static/ddetxzp0gv1buk1ev67b8ynik7f268hw.xz) | :heavy_check_mark: | | |\n|convert_tendl| TENDL | 2015<br>2017<br>2019<br>2021| | | :heavy_check_mark: | | | -->\n\n## Produce Depletion Chain files\n\n### Generate chain files\n\n| Script name | Library | Release |\n|-|-|-|\n|generate_endf_chain | ENDF/B | VII.1<br>VIII.0 |\n|generate_jeff_chain | JEFF | 3.3 |\n|generate_serpent_fissq | | |\n|generate_tendl_chain | TENDL | 2019<br>2021 |\n|generate_endf71_chain_casl | ENDF/B | |\n\n### Download chain files\n\n| Script name | Library | Release | Branching options|\n|-|-|-|-|\n|download_endf_chain | ENDF/B | VII.1<br>VIII.0 | None<br>SFR<br>PWR\n\n<!-- | Sctipt name | Library | Release | Download available | Download ENDF files and generates XML chain files |\n|-|-|-|-|-|\n|generate_endf71_chain_casl|ENDF/B|-|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:|\n|generate_endf_chain|ENDF/B|-|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:|\n|generate_serpent_fissq|-|-|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:|\n|generate_tendl_chain|TENDL|2019<br>2021|[https://github.com/openmc-dev/data/tree/master/depletion](https://github.com/openmc-dev/data/tree/master/depletion)|:heavy_check_mark:| -->\n\n## Other scripts\n\n| Script name | Description |\n|-|-|\n| convert_tendl_rand | Download random TENDL libraries from PSI and convert it to a HDF5 library for use with OpenMC. Only certain nuclides are available from PSI. This script generates a cross_sections_tendl.xml file with random TENDL evaluations plus a standard library located in 'OPENMC_CROSS_SECTIONS' |\n| sample_sandy | This scripts generates random (gaussian) evaluations of a nuclear data file following its covariance matrix using SANDY, and converts them to HDF5 for use in OpenMC. Script generates a cross_sections_sandy.xml file with the standard library plus the sampled evaluations. |\n| make_compton | |\n| make_stopping_powers | |\n| add_branching_ratios | add branching ratios for n,gamma reactions to a preexisting chain files. |\n| reduce_chain | |\n| combine_libraries | Combines multiple cross_section.xml files into a single cross_section.xml. |\n",
"bugtrack_url": null,
"license": "Copyright (c) 2019-2022 UChicago Argonne LLC and contributors 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. ",
"summary": "A Python package containing a collection of scripts for producing and downloading data for OpenMC",
"version": "2.2.8",
"project_urls": {
"Bug Tracker": "https://github.com/fusion-energy/openmc_data/issues",
"Homepage": "https://github.com/fusion-energy/openmc_data"
},
"split_keywords": [
"openmc",
"nuclear",
"data",
"download",
"process",
"cross",
"section"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e4c91510e4a409eaab0954018fc0fdb3e3a3a0441f6d15f82a596210f9323f2",
"md5": "f745918bb87292dedbd0fd193e4baac0",
"sha256": "9ef2f21714f6fd860fd74505566e0cebdb4a92f82d702621e6e5a5b143b653c4"
},
"downloads": -1,
"filename": "openmc_data-2.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f745918bb87292dedbd0fd193e4baac0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 58353699,
"upload_time": "2024-02-22T17:59:47",
"upload_time_iso_8601": "2024-02-22T17:59:47.501972Z",
"url": "https://files.pythonhosted.org/packages/4e/4c/91510e4a409eaab0954018fc0fdb3e3a3a0441f6d15f82a596210f9323f2/openmc_data-2.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5548492c06fc27506cae91b8eb4104aef39d63a495a2e09d125ab006da31920a",
"md5": "6a223aec27694413c7f0aa0caa3c8ae5",
"sha256": "b72e7612ab8c3cc34b09021c00f910c641ef9a452a6eab6592f2876bcec745d1"
},
"downloads": -1,
"filename": "openmc_data-2.2.8.tar.gz",
"has_sig": false,
"md5_digest": "6a223aec27694413c7f0aa0caa3c8ae5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 58039444,
"upload_time": "2024-02-22T17:59:52",
"upload_time_iso_8601": "2024-02-22T17:59:52.845895Z",
"url": "https://files.pythonhosted.org/packages/55/48/492c06fc27506cae91b8eb4104aef39d63a495a2e09d125ab006da31920a/openmc_data-2.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 17:59:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fusion-energy",
"github_project": "openmc_data",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openmc-data"
}
