<commit_before>.. _io_statepoint:

=======================
State Point File Format
=======================

The current version of the statepoint file format is 17.0.

**/**

:Attributes: - **filetype** (*char[]*) -- String indicating the type of file.
             - **version** (*int[2]*) -- Major and minor version of the
               statepoint file format.
             - **openmc_version** (*int[3]*) -- Major, minor, and release
               version number for OpenMC.
             - **git_sha1** (*char[40]*) -- Git commit SHA-1 hash.
             - **date_and_time** (*char[]*) -- Date and time the summary was
               written.
             - **path** (*char[]*) -- Path to directory containing input files.
             - **tallies_present** (*int*) -- Flag indicating whether tallies
               are present (1) or not (0).
             - **source_present** (*int*) -- Flag indicating whether the source
               bank is present (1) or not (0).

:Datasets: - **seed** (*int8_t*) -- Pseudo-random number generator seed.
           - **energy_mode** (*char[]*) -- Energy mode of the run, either
             'continuous-energy' or 'multi-group'.
           - **run_mode** (*char[]*) -- Run mode used, either 'eigenvalue' or
             'fixed source'.
           - **n_particles** (*int8_t*) -- Number of particles used per generation.
           - **n_batches** (*int*) -- Number of batches to simulate.
           - **current_batch** (*int*) -- The number of batches already simulated.
           - **n_inactive** (*int*) -- Number of inactive batches. Only present
             when `run_mode` is 'eigenvalue'.
           - **generations_per_batch** (*int*) -- Number of generations per
             batch. Only present when `run_mode` is 'eigenvalue'.
           - **k_generation** (*double[]*) -- k-effective for each generation
             simulated.
           - **entropy** (*double[]*) -- Shannon entropy for each generation
             simulated.
           - **k_col_abs** (*double*) -- Sum of product of collision/absorption
             estimates of k-effective.
           - **k_col_tra** (*double*) -- Sum of product of
             collision/track-length estimates of k-effective.
           - **k_abs_tra** (*double*) -- Sum of product of
             absorption/track-length estimates of k-effective.
           - **k_combined** (*double[2]*) -- Mean and standard deviation of a
             combined estimate of k-effective.
           - **n_realizations** (*int*) -- Number of realizations for global
             tallies.
           - **global_tallies** (*double[][2]*) -- Accumulated sum and
             sum-of-squares for each global tally.
           - **source_bank** (Compound type) -- Source bank information for each
             particle. The compound type has fields ``r``, ``u``, ``E``,
             ``wgt``, ``delayed_group``, and ``particle``, which represent the
             position, direction, energy, weight, delayed group, and particle
             type (0=neutron, 1=photon, 2=electron, 3=positron), respectively.
             Only present when `run_mode` is 'eigenvalue'.

**/tallies/**<commit_msg>Add missing changes on statepoint.rst<commit_after>.. _io_statepoint:

=======================
State Point File Format
=======================

The current version of the statepoint file format is 17.0.

**/**

:Attributes: - **filetype** (*char[]*) -- String indicating the type of file.
             - **version** (*int[2]*) -- Major and minor version of the
               statepoint file format.
             - **openmc_version** (*int[3]*) -- Major, minor, and release
               version number for OpenMC.
             - **git_sha1** (*char[40]*) -- Git commit SHA-1 hash.
             - **date_and_time** (*char[]*) -- Date and time the summary was
               written.
             - **path** (*char[]*) -- Path to directory containing input files.
             - **tallies_present** (*int*) -- Flag indicating whether tallies
               are present (1) or not (0).
             - **source_present** (*int*) -- Flag indicating whether the source
               bank is present (1) or not (0).

:Datasets: - **seed** (*int8_t*) -- Pseudo-random number generator seed.
           - **energy_mode** (*char[]*) -- Energy mode of the run, either
             'continuous-energy' or 'multi-group'.
           - **run_mode** (*char[]*) -- Run mode used, either 'eigenvalue' or
             'fixed source'.
           - **n_particles** (*int8_t*) -- Number of particles used per generation.
           - **n_batches** (*int*) -- Number of batches to simulate.
           - **current_batch** (*int*) -- The number of batches already simulated.
           - **n_inactive** (*int*) -- Number of inactive batches. Only present
             when `run_mode` is 'eigenvalue'.
           - **generations_per_batch** (*int*) -- Number of generations per
             batch. Only present when `run_mode` is 'eigenvalue'.
           - **k_generation** (*double[]*) -- k-effective for each generation
             simulated.
           - **entropy** (*double[]*) -- Shannon entropy for each generation
             simulated.
           - **k_col_abs** (*double*) -- Sum of product of collision/absorption
             estimates of k-effective.
           - **k_col_tra** (*double*) -- Sum of product of
             collision/track-length estimates of k-effective.
           - **k_abs_tra** (*double*) -- Sum of product of
             absorption/track-length estimates of k-effective.
           - **k_combined** (*double[2]*) -- Mean and standard deviation of a
             combined estimate of k-effective.
           - **n_realizations** (*int*) -- Number of realizations for global
             tallies.
           - **global_tallies** (*double[][2]*) -- Accumulated sum and
             sum-of-squares for each global tally.
           - **source_bank** (Compound type) -- Source bank information for each
             particle. The compound type has fields ``r``, ``u``, ``E``,
             ``wgt``, ``delayed_group``, ``surf_id``, and ``particle``, which
             represent the position, direction, energy, weight, delayed group,
             surface ID, and particle type (0=neutron, 1=photon, 2=electron,
             3=positron), respectively.
             Only present when `run_mode` is 'eigenvalue'.

**/tallies/**
{'fraction_non_alphanumeric': 0.15407430533874492, 'fraction_numerical': 0.006556353418669997, 'mean_word_length': 2.050952380952381, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7541673', 'n_tokens_mistral': 1722, 'n_tokens_neox': 1677, 'n_words': 588}