Dataset Viewer
Auto-converted to Parquet Duplicate
instruction
stringlengths
34
96
input
stringlengths
27
97
output
stringlengths
53
3.6k
What does the clean_indentation() function do in OpenMC's Python API?
OpenMC Python API clean_indentation() function
The clean_indentation() function set indentation of xml element and its sub-elements. copied and pasted from https://effbot.org/zone/element-lib.htm#prettyprint. it walks your tree and adds spaces and newlines so the tree is printed in a nice way. It's used for Python operations in OpenMC.
What is the purpose of the clean_indentation() function in OpenMC's Python API?
OpenMC Python API clean_indentation() function purpose
The clean_indentation() function set indentation of xml element and its sub-elements. copied and pasted from https://effbot.org/zone/element-lib.htm#prettyprint. it walks your tree and adds spaces and newlines so the tree is printed in a nice way. It's part of OpenMC's Python API.
How do you call the clean_indentation() function in OpenMC's Python API?
OpenMC Python API clean_indentation() function signature
To call the clean_indentation() function, use: def clean_indentation(element: Any, level: Any, spaces_per_level: Any, trailing_indent: Any). It takes 4 parameters.
What does the level parameter do in the clean_indentation() function?
OpenMC Python API clean_indentation() parameter level
The level parameter indentation level for the element passed in (default 0). It should be a int value.
What does the spaces_per_level parameter do in the clean_indentation() function?
OpenMC Python API clean_indentation() parameter spaces_per_level
The spaces_per_level parameter number of spaces per indentation level (default 2). It should be a int value.
What does the trailing_indent parameter do in the clean_indentation() function?
OpenMC Python API clean_indentation() parameter trailing_indent
The trailing_indent parameter whether or not to add indentation after closing the element. It should be a bool value.
What does the get_text() function do in OpenMC's Python API?
OpenMC Python API get_text() function
The get_text() function retrieve text of an attribute or subelement. It's used for Python operations in OpenMC.
What is the purpose of the get_text() function in OpenMC's Python API?
OpenMC Python API get_text() function purpose
The get_text() function retrieve text of an attribute or subelement. It's part of OpenMC's Python API.
How do you call the get_text() function in OpenMC's Python API?
OpenMC Python API get_text() function signature
To call the get_text() function, use: def get_text(elem: Any, name: Any, default: Any). It takes 3 parameters.
What does the elem parameter do in the get_text() function?
OpenMC Python API get_text() parameter elem
The elem parameter element from which to search. It should be a lxml.etree._Element value.
What does the name parameter do in the get_text() function?
OpenMC Python API get_text() parameter name
The name parameter name of attribute/subelement. It should be a str value.
What does the default parameter do in the get_text() function?
OpenMC Python API get_text() parameter default
The default parameter a defult value to return if matching attribute/subelement exists. It should be a object value.
What does the reorder_attributes() function do in OpenMC's Python API?
OpenMC Python API reorder_attributes() function
The reorder_attributes() function sort attributes in xml to preserve pre-python 3.8 behavior. It's used for Python operations in OpenMC.
What is the purpose of the reorder_attributes() function in OpenMC's Python API?
OpenMC Python API reorder_attributes() function purpose
The reorder_attributes() function sort attributes in xml to preserve pre-python 3.8 behavior. It's part of OpenMC's Python API.
How do you call the reorder_attributes() function in OpenMC's Python API?
OpenMC Python API reorder_attributes() function signature
To call the reorder_attributes() function, use: def reorder_attributes(root: Any). It takes 1 parameters.
What does the root parameter do in the reorder_attributes() function?
OpenMC Python API reorder_attributes() parameter root
The root parameter root element. It should be a lxml.etree._Element value.
What does the get_elem_tuple() function do in OpenMC's Python API?
OpenMC Python API get_elem_tuple() function
The get_elem_tuple() function helper function to get a tuple of values from an elem. It's used for Python operations in OpenMC.
What is the purpose of the get_elem_tuple() function in OpenMC's Python API?
OpenMC Python API get_elem_tuple() function purpose
The get_elem_tuple() function helper function to get a tuple of values from an elem. It's part of OpenMC's Python API.
How do you call the get_elem_tuple() function in OpenMC's Python API?
OpenMC Python API get_elem_tuple() function signature
To call the get_elem_tuple() function, use: def get_elem_tuple(elem: Any, name: Any, dtype: Any). It takes 3 parameters.
What does the elem parameter do in the get_elem_tuple() function?
OpenMC Python API get_elem_tuple() parameter elem
The elem parameter xml element that should contain a tuple. It should be a lxml.etree._Element value.
What does the name parameter do in the get_elem_tuple() function?
OpenMC Python API get_elem_tuple() parameter name
The name parameter name of the subelement to obtain tuple from. It should be a str value.
What does the dtype parameter do in the get_elem_tuple() function?
OpenMC Python API get_elem_tuple() parameter dtype
The dtype parameter the type of each element in the tuple. It should be a data-type value.
What is the CrossScore class in OpenMC's Python API?
OpenMC Python API CrossScore class
The CrossScore class represents a special-purpose tally score used to encapsulate all combinations of two tally's scores as an outer product for tally arithmetic. It provides 10 methods and 0 properties for working with crossscore data in OpenMC.
What does the CrossScore class do in OpenMC's Python API?
OpenMC Python API CrossScore class description
The CrossScore class a special-purpose tally score used to encapsulate all combinations of two tally's scores as an outer product for tally arithmetic. It's used in OpenMC's Python API for nuclear data operations.
What does the left_score parameter do when creating a CrossScore?
OpenMC Python API CrossScore constructor parameter left_score
When creating a CrossScore, the left_score parameter specifies the left score in the outer product. It should be a str or CrossScore value.
What does the right_score parameter do when creating a CrossScore?
OpenMC Python API CrossScore constructor parameter right_score
When creating a CrossScore, the right_score parameter specifies the right score in the outer product. It should be a str or CrossScore value.
What does the binary_op parameter do when creating a CrossScore?
OpenMC Python API CrossScore constructor parameter binary_op
When creating a CrossScore, the binary_op parameter specifies the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's scores with this crossnuclide. It should be a str value.
What is the left_score attribute of a CrossScore?
OpenMC Python API CrossScore attribute left_score
The left_score attribute of a CrossScore contains the left score in the outer product. It's a str or CrossScore value that you can access after creating a CrossScore instance.
What is the right_score attribute of a CrossScore?
OpenMC Python API CrossScore attribute right_score
The right_score attribute of a CrossScore contains the right score in the outer product. It's a str or CrossScore value that you can access after creating a CrossScore instance.
What is the binary_op attribute of a CrossScore?
OpenMC Python API CrossScore attribute binary_op
The binary_op attribute of a CrossScore contains the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's scores with this crossscore. It's a str value that you can access after creating a CrossScore instance.
How do you call the __init__() method in the CrossScore class?
OpenMC Python API CrossScore.__init__() method signature
To call the __init__() method, use: def __init__(self: Any, left_score: Any, right_score: Any, binary_op: Any). It takes 4 parameters.
How do you call the __hash__() method in the CrossScore class?
OpenMC Python API CrossScore.__hash__() method signature
To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters.
How do you call the __eq__() method in the CrossScore class?
OpenMC Python API CrossScore.__eq__() method signature
To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters.
How do you call the __repr__() method in the CrossScore class?
OpenMC Python API CrossScore.__repr__() method signature
To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters.
How do you call the left_score() method in the CrossScore class?
OpenMC Python API CrossScore.left_score() method signature
To call the left_score() method, use: @property def left_score(self: Any). It takes 1 parameters.
How do you call the left_score() method in the CrossScore class?
OpenMC Python API CrossScore.left_score() method signature
To call the left_score() method, use: @left_score.setter def left_score(self: Any, left_score: Any). It takes 2 parameters.
How do you call the right_score() method in the CrossScore class?
OpenMC Python API CrossScore.right_score() method signature
To call the right_score() method, use: @property def right_score(self: Any). It takes 1 parameters.
How do you call the right_score() method in the CrossScore class?
OpenMC Python API CrossScore.right_score() method signature
To call the right_score() method, use: @right_score.setter def right_score(self: Any, right_score: Any). It takes 2 parameters.
How do you call the binary_op() method in the CrossScore class?
OpenMC Python API CrossScore.binary_op() method signature
To call the binary_op() method, use: @property def binary_op(self: Any). It takes 1 parameters.
How do you call the binary_op() method in the CrossScore class?
OpenMC Python API CrossScore.binary_op() method signature
To call the binary_op() method, use: @binary_op.setter def binary_op(self: Any, binary_op: Any). It takes 2 parameters.
What is the CrossNuclide class in OpenMC's Python API?
OpenMC Python API CrossNuclide class
The CrossNuclide class represents a special-purpose nuclide used to encapsulate all combinations of two tally's nuclides as an outer product for tally arithmetic. It provides 11 methods and 0 properties for working with crossnuclide data in OpenMC.
What does the CrossNuclide class do in OpenMC's Python API?
OpenMC Python API CrossNuclide class description
The CrossNuclide class a special-purpose nuclide used to encapsulate all combinations of two tally's nuclides as an outer product for tally arithmetic. It's used in OpenMC's Python API for nuclear data operations.
What does the left_nuclide parameter do when creating a CrossNuclide?
OpenMC Python API CrossNuclide constructor parameter left_nuclide
When creating a CrossNuclide, the left_nuclide parameter specifies the left nuclide in the outer product. It should be a str or CrossNuclide value.
What does the right_nuclide parameter do when creating a CrossNuclide?
OpenMC Python API CrossNuclide constructor parameter right_nuclide
When creating a CrossNuclide, the right_nuclide parameter specifies the right nuclide in the outer product. It should be a str or CrossNuclide value.
What does the binary_op parameter do when creating a CrossNuclide?
OpenMC Python API CrossNuclide constructor parameter binary_op
When creating a CrossNuclide, the binary_op parameter specifies the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's nuclides with this crossnuclide. It should be a str value.
What is the left_nuclide attribute of a CrossNuclide?
OpenMC Python API CrossNuclide attribute left_nuclide
The left_nuclide attribute of a CrossNuclide contains the left nuclide in the outer product. It's a str or CrossNuclide value that you can access after creating a CrossNuclide instance.
What is the right_nuclide attribute of a CrossNuclide?
OpenMC Python API CrossNuclide attribute right_nuclide
The right_nuclide attribute of a CrossNuclide contains the right nuclide in the outer product. It's a str or CrossNuclide value that you can access after creating a CrossNuclide instance.
What is the binary_op attribute of a CrossNuclide?
OpenMC Python API CrossNuclide attribute binary_op
The binary_op attribute of a CrossNuclide contains the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's nuclides with this crossnuclide. It's a str value that you can access after creating a CrossNuclide instance.
How do you call the __init__() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.__init__() method signature
To call the __init__() method, use: def __init__(self: Any, left_nuclide: Any, right_nuclide: Any, binary_op: Any). It takes 4 parameters.
How do you call the __hash__() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.__hash__() method signature
To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters.
How do you call the __eq__() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.__eq__() method signature
To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters.
How do you call the __repr__() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.__repr__() method signature
To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters.
How do you call the left_nuclide() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.left_nuclide() method signature
To call the left_nuclide() method, use: @property def left_nuclide(self: Any). It takes 1 parameters.
How do you call the left_nuclide() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.left_nuclide() method signature
To call the left_nuclide() method, use: @left_nuclide.setter def left_nuclide(self: Any, left_nuclide: Any). It takes 2 parameters.
How do you call the right_nuclide() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.right_nuclide() method signature
To call the right_nuclide() method, use: @property def right_nuclide(self: Any). It takes 1 parameters.
How do you call the right_nuclide() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.right_nuclide() method signature
To call the right_nuclide() method, use: @right_nuclide.setter def right_nuclide(self: Any, right_nuclide: Any). It takes 2 parameters.
How do you call the binary_op() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.binary_op() method signature
To call the binary_op() method, use: @property def binary_op(self: Any). It takes 1 parameters.
How do you call the binary_op() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.binary_op() method signature
To call the binary_op() method, use: @binary_op.setter def binary_op(self: Any, binary_op: Any). It takes 2 parameters.
How do you call the name() method in the CrossNuclide class?
OpenMC Python API CrossNuclide.name() method signature
To call the name() method, use: @property def name(self: Any). It takes 1 parameters.
What is the CrossFilter class in OpenMC's Python API?
OpenMC Python API CrossFilter class
The CrossFilter class represents a special-purpose filter used to encapsulate all combinations of two tally's filter bins as an outer product for tally arithmetic. It provides 15 methods and 0 properties for working with crossfilter data in OpenMC.
What does the CrossFilter class do in OpenMC's Python API?
OpenMC Python API CrossFilter class description
The CrossFilter class a special-purpose filter used to encapsulate all combinations of two tally's filter bins as an outer product for tally arithmetic. It's used in OpenMC's Python API for nuclear data operations.
What does the left_filter parameter do when creating a CrossFilter?
OpenMC Python API CrossFilter constructor parameter left_filter
When creating a CrossFilter, the left_filter parameter specifies the left filter in the outer product. It should be a openmc.Filter or CrossFilter value.
What does the right_filter parameter do when creating a CrossFilter?
OpenMC Python API CrossFilter constructor parameter right_filter
When creating a CrossFilter, the right_filter parameter specifies the right filter in the outer product. It should be a openmc.Filter or CrossFilter value.
What does the binary_op parameter do when creating a CrossFilter?
OpenMC Python API CrossFilter constructor parameter binary_op
When creating a CrossFilter, the binary_op parameter specifies the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's filter bins with this crossfilter. It should be a str value.
What is the type attribute of a CrossFilter?
OpenMC Python API CrossFilter attribute type
The type attribute of a CrossFilter contains the type of the crossfilter (e.g., 'energy / energy'). It's a str value that you can access after creating a CrossFilter instance.
What is the left_filter attribute of a CrossFilter?
OpenMC Python API CrossFilter attribute left_filter
The left_filter attribute of a CrossFilter contains the left filter in the outer product. It's a openmc.Filter or CrossFilter value that you can access after creating a CrossFilter instance.
What is the right_filter attribute of a CrossFilter?
OpenMC Python API CrossFilter attribute right_filter
The right_filter attribute of a CrossFilter contains the right filter in the outer product. It's a openmc.Filter or CrossFilter value that you can access after creating a CrossFilter instance.
What is the binary_op attribute of a CrossFilter?
OpenMC Python API CrossFilter attribute binary_op
The binary_op attribute of a CrossFilter contains the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's filter bins with this crossfilter. It's a str value that you can access after creating a CrossFilter instance.
What is the bins attribute of a CrossFilter?
OpenMC Python API CrossFilter attribute bins
The bins attribute of a CrossFilter contains a dictionary of the bins from each filter keyed by the types of the left / right filters. It's a dict of Iterable value that you can access after creating a CrossFilter instance.
What is the num_bins attribute of a CrossFilter?
OpenMC Python API CrossFilter attribute num_bins
The num_bins attribute of a CrossFilter contains the number of filter bins (always 1 if aggregate_filter is defined). It's a Integral value that you can access after creating a CrossFilter instance.
How do you call the __init__() method in the CrossFilter class?
OpenMC Python API CrossFilter.__init__() method signature
To call the __init__() method, use: def __init__(self: Any, left_filter: Any, right_filter: Any, binary_op: Any). It takes 4 parameters.
How do you call the __hash__() method in the CrossFilter class?
OpenMC Python API CrossFilter.__hash__() method signature
To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters.
How do you call the __eq__() method in the CrossFilter class?
OpenMC Python API CrossFilter.__eq__() method signature
To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters.
How do you call the __repr__() method in the CrossFilter class?
OpenMC Python API CrossFilter.__repr__() method signature
To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters.
How do you call the left_filter() method in the CrossFilter class?
OpenMC Python API CrossFilter.left_filter() method signature
To call the left_filter() method, use: @property def left_filter(self: Any). It takes 1 parameters.
How do you call the left_filter() method in the CrossFilter class?
OpenMC Python API CrossFilter.left_filter() method signature
To call the left_filter() method, use: @left_filter.setter def left_filter(self: Any, left_filter: Any). It takes 2 parameters.
How do you call the right_filter() method in the CrossFilter class?
OpenMC Python API CrossFilter.right_filter() method signature
To call the right_filter() method, use: @property def right_filter(self: Any). It takes 1 parameters.
How do you call the right_filter() method in the CrossFilter class?
OpenMC Python API CrossFilter.right_filter() method signature
To call the right_filter() method, use: @right_filter.setter def right_filter(self: Any, right_filter: Any). It takes 2 parameters.
How do you call the binary_op() method in the CrossFilter class?
OpenMC Python API CrossFilter.binary_op() method signature
To call the binary_op() method, use: @property def binary_op(self: Any). It takes 1 parameters.
How do you call the binary_op() method in the CrossFilter class?
OpenMC Python API CrossFilter.binary_op() method signature
To call the binary_op() method, use: @binary_op.setter def binary_op(self: Any, binary_op: Any). It takes 2 parameters.
How do you call the type() method in the CrossFilter class?
OpenMC Python API CrossFilter.type() method signature
To call the type() method, use: @property def type(self: Any). It takes 1 parameters.
How do you call the bins() method in the CrossFilter class?
OpenMC Python API CrossFilter.bins() method signature
To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters.
How do you call the num_bins() method in the CrossFilter class?
OpenMC Python API CrossFilter.num_bins() method signature
To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters.
What does the get_bin_index() method do in the CrossFilter class?
OpenMC Python API CrossFilter.get_bin_index() method
The get_bin_index() method returns the index in the crossfilter for some bin. It's used for crossfilter operations.
How do you call the get_bin_index() method in the CrossFilter class?
OpenMC Python API CrossFilter.get_bin_index() method signature
To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters.
What does the filter_bin parameter do in the get_bin_index() method?
OpenMC Python API CrossFilter.get_bin_index() parameter filter_bin
The filter_bin parameter a 2-tuple where each value corresponds to the bin of interest in the left and right filter, respectively. a bin is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. the bin is an integer for the cell instance id for 'distribcell' filters. the bin is a 2-tuple...
What does the get_bin_index() method return in the CrossFilter class?
OpenMC Python API CrossFilter.get_bin_index() return value
The get_bin_index() method returns the index in the tally data array for this filter bin.. The return type is Integral.
What does the get_pandas_dataframe() method do in the CrossFilter class?
OpenMC Python API CrossFilter.get_pandas_dataframe() method
The get_pandas_dataframe() method builds a pandas dataframe for the crossfilter's bins. this method constructs a pandas dataframe object for the crossfilter with columns annotated by filter bin information. this is a helper method for the tally.get_pandas_dataframe(...) method. this method recursively builds and concat...
How do you call the get_pandas_dataframe() method in the CrossFilter class?
OpenMC Python API CrossFilter.get_pandas_dataframe() method signature
To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, summary: Any). It takes 3 parameters.
What does the data_size parameter do in the get_pandas_dataframe() method?
OpenMC Python API CrossFilter.get_pandas_dataframe() parameter data_size
The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a Integral value.
What does the summary parameter do in the get_pandas_dataframe() method?
OpenMC Python API CrossFilter.get_pandas_dataframe() parameter summary
The summary parameter an optional summary object to be used to construct columns for distribcell tally filters (default is none). the geometric information in the summary object is embedded into a multi-index column with a geometric "path" to each distribcell instance.. It should be a None or Summary value.
What is the AggregateScore class in OpenMC's Python API?
OpenMC Python API AggregateScore class
The AggregateScore class represents a special-purpose tally score used to encapsulate an aggregate of a subset or all of tally's scores for tally aggregation. It provides 9 methods and 0 properties for working with aggregatescore data in OpenMC.
What does the AggregateScore class do in OpenMC's Python API?
OpenMC Python API AggregateScore class description
The AggregateScore class a special-purpose tally score used to encapsulate an aggregate of a subset or all of tally's scores for tally aggregation. It's used in OpenMC's Python API for nuclear data operations.
What does the scores parameter do when creating a AggregateScore?
OpenMC Python API AggregateScore constructor parameter scores
When creating a AggregateScore, the scores parameter specifies the scores included in the aggregation. It should be a Iterable of str or CrossScore value.
What does the aggregate_op parameter do when creating a AggregateScore?
OpenMC Python API AggregateScore constructor parameter aggregate_op
When creating a AggregateScore, the aggregate_op parameter specifies the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally's scores with this aggregatescore. It should be a str value.
What is the scores attribute of a AggregateScore?
OpenMC Python API AggregateScore attribute scores
The scores attribute of a AggregateScore contains the scores included in the aggregation. It's a Iterable of str or CrossScore value that you can access after creating a AggregateScore instance.
What is the aggregate_op attribute of a AggregateScore?
OpenMC Python API AggregateScore attribute aggregate_op
The aggregate_op attribute of a AggregateScore contains the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally's scores with this aggregatescore. It's a str value that you can access after creating a AggregateScore instance.
How do you call the __init__() method in the AggregateScore class?
OpenMC Python API AggregateScore.__init__() method signature
To call the __init__() method, use: def __init__(self: Any, scores: Any, aggregate_op: Any). It takes 3 parameters.
How do you call the __hash__() method in the AggregateScore class?
OpenMC Python API AggregateScore.__hash__() method signature
To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters.
How do you call the __eq__() method in the AggregateScore class?
OpenMC Python API AggregateScore.__eq__() method signature
To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters.
End of preview. Expand in Data Studio
README.md exists but content is empty.
Downloads last month
4

Models trained or fine-tuned on hitarths/openmc-python