Skip to content

Tweak documentation for alara_output_processing #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anu1217 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Tweak documentation for alara_output_processing #318

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e01a46
make corrections
anu1217 Aug 5, 2026
145395c
fix alignment with header
anu1217 Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The columns for `adfs` are:
* `nuclide`: Nuclide name formatted as "element-A" (i.e. "h-1" for <sup>1</sup>H) or "total".
* `half_life`: Half-life in seconds of an unstable nuclide. `-1` for stable nuclides, `0` for "total" rows.
* `run_lbl`: Distinguisher between runs (i.e. "run1", "run2", etc.).
* `block`: Integer enumerator for the geometric block key name. Possible block keys are "Interval", "Material", or "Zone", and their enumerator values can be accessed through `ALARADFrame().BLOCK_ENUM[block]`, where `block` is one of the above keys. For FISPACT-II data, `block`, `block_name`, and `block_num` are all set to `-1`.
* `block`: Integer enumerator for the geometric block key name. Possible block keys are "Interval", "Zone", or "Material", and their enumerator values can be accessed through `ALARADFrame().BLOCK_ENUM[block]`, where `block` is one of the above keys. For FISPACT-II data, `block`, `block_name`, and `block_num` are all set to `-1`.
* `block_name`: Name of the block.
* `block_num`: Geometric position of the block.
* `variable`: Integer enumerator for the response variable key name. Possible variable keys are:
Expand All @@ -94,15 +94,15 @@ The columns for `adfs` are:
Below is the example `head()` of an `ALARADFrame`:


||time|time_unit|nuclide|half_life|run_lbl|block|block_num|variable| var_unit|value|
|-|-|-|-|-|-|-|-|-|-|-|
| 0 | -1 | 's' | h-1 | -1 | fendl2 | 0 | 1 | 0 | atoms/kg | 0.000000e+0
| 1 | 0.000000e+00| 's' | h-1 | -1 | fendl2 | 0 | 1 | 0 | atoms/kg | 1.176100e+22
| 2 | 3.153600e+02 | 's' | h-1 | -1 | fendl2 | 0 | 1 | 0 | atoms/kg | 1.176100e+22
| 3 | 3.153600e+05 |'s' | h-1 | -1 | fendl2 | 0 | 1 | 0 | atoms/kg | 1.176100e+22
| 4 | 3.153600e+07 | 's' | h-1 | -1 | fendl2 | 0 | 1 | 0 | atoms/kg | 1.176100e+22
||time|time_unit|nuclide|half_life|run_lbl|block|block_name|block_num|variable| var_unit|value|
|-|-|-|-|-|-|-|-|-|-|-|-|
| 0 | -1 | 's' | h-1 | -1 | fendl2 | 0 | int_1 | 1 | 0 | atoms/kg | 0.000000e+0
| 1 | 0.000000e+00| 's' | h-1 | -1 | fendl2 | 0 | int_1 | 1 | 0 | atoms/kg | 1.176100e+22
| 2 | 3.153600e+02 | 's' | h-1 | -1 | fendl2 | 0 | int_1 | 1 | 0 | atoms/kg | 1.176100e+22
| 3 | 3.153600e+05 |'s' | h-1 | -1 | fendl2 | 0 | int_1 | 1 | 0 | atoms/kg | 1.176100e+22
| 4 | 3.153600e+07 | 's' | h-1 | -1 | fendl2 | 0 | int_1 | 1 | 0 | atoms/kg | 1.176100e+22

The five rows in the head correspond to the number density of <sup>1</sup>H in the 1st interval of a run of FENDL2 data with four cooling times. Note that the 0<sup>th</sup> row's time of `-1` corresponds to the pre-irradiation state, and not any singular cooling time, like all positive and zero times do.
The five rows in the head correspond to the number density of <sup>1</sup>H in the 1st interval of a run of FENDL2 data with four cooling times. Note that the 0<sup>th</sup> row's time of `-1` corresponds to the pre-irradiation state, and not any singular cooling time, like all positive and zero times do. The shutdown time is equivalent to a cooling time of 0.

Once `adf` is created, `ALARADFrame.filter_rows()` can be called to select data that matches user specifications for one or more columns:

Expand Down
Loading