partition
stringclasses
3 values
func_name
stringlengths
1
134
docstring
stringlengths
1
46.9k
path
stringlengths
4
223
original_string
stringlengths
75
104k
code
stringlengths
75
104k
docstring_tokens
listlengths
1
1.97k
repo
stringlengths
7
55
language
stringclasses
1 value
url
stringlengths
87
315
code_tokens
listlengths
19
28.4k
sha
stringlengths
40
40
valid
_BaseWrapper.get_local_playlists
Load playlists from local filepaths. Parameters: filepaths (list or str): Filepath(s) to search for music files. exclude_patterns (list or str): Pattern(s) to exclude. Patterns are Python regex patterns. Filepaths are excluded if they match any of the exclude patterns. max_depth (int): The depth i...
gmusicapi_wrapper/base.py
def get_local_playlists(filepaths, exclude_patterns=None, max_depth=float('inf')): """Load playlists from local filepaths. Parameters: filepaths (list or str): Filepath(s) to search for music files. exclude_patterns (list or str): Pattern(s) to exclude. Patterns are Python regex patterns. Filepaths ...
def get_local_playlists(filepaths, exclude_patterns=None, max_depth=float('inf')): """Load playlists from local filepaths. Parameters: filepaths (list or str): Filepath(s) to search for music files. exclude_patterns (list or str): Pattern(s) to exclude. Patterns are Python regex patterns. Filepaths ...
[ "Load", "playlists", "from", "local", "filepaths", "." ]
thebigmunch/gmusicapi-wrapper
python
https://github.com/thebigmunch/gmusicapi-wrapper/blob/8708683cd33955def1378fc28319ef37805b851d/gmusicapi_wrapper/base.py#L95-L126
[ "def", "get_local_playlists", "(", "filepaths", ",", "exclude_patterns", "=", "None", ",", "max_depth", "=", "float", "(", "'inf'", ")", ")", ":", "logger", ".", "info", "(", "\"Loading local playlists...\"", ")", "included_playlists", "=", "[", "]", "excluded_p...
8708683cd33955def1378fc28319ef37805b851d
valid
_BaseWrapper.get_local_playlist_songs
Load songs from local playlist. Parameters: playlist (str): An M3U(8) playlist filepath. include_filters (list): A list of ``(field, pattern)`` tuples. Fields are any valid mutagen metadata fields. Patterns are Python regex patterns. Local songs are filtered out if the given metadata field values don'...
gmusicapi_wrapper/base.py
def get_local_playlist_songs( playlist, include_filters=None, exclude_filters=None, all_includes=False, all_excludes=False, exclude_patterns=None): """Load songs from local playlist. Parameters: playlist (str): An M3U(8) playlist filepath. include_filters (list): A list of ``(field, pattern)`` tuples. ...
def get_local_playlist_songs( playlist, include_filters=None, exclude_filters=None, all_includes=False, all_excludes=False, exclude_patterns=None): """Load songs from local playlist. Parameters: playlist (str): An M3U(8) playlist filepath. include_filters (list): A list of ``(field, pattern)`` tuples. ...
[ "Load", "songs", "from", "local", "playlist", "." ]
thebigmunch/gmusicapi-wrapper
python
https://github.com/thebigmunch/gmusicapi-wrapper/blob/8708683cd33955def1378fc28319ef37805b851d/gmusicapi_wrapper/base.py#L129-L193
[ "def", "get_local_playlist_songs", "(", "playlist", ",", "include_filters", "=", "None", ",", "exclude_filters", "=", "None", ",", "all_includes", "=", "False", ",", "all_excludes", "=", "False", ",", "exclude_patterns", "=", "None", ")", ":", "logger", ".", "...
8708683cd33955def1378fc28319ef37805b851d
valid
Material._prepare_lines_
Prepare the lines read from the text file before starting to process it.
auxi/modelling/process/materials/chem.py
def _prepare_lines_(self, lines): """ Prepare the lines read from the text file before starting to process it. """ result = [] for line in lines: # Remove all whitespace from the start and end of the line. line = line.strip() # Replac...
def _prepare_lines_(self, lines): """ Prepare the lines read from the text file before starting to process it. """ result = [] for line in lines: # Remove all whitespace from the start and end of the line. line = line.strip() # Replac...
[ "Prepare", "the", "lines", "read", "from", "the", "text", "file", "before", "starting", "to", "process", "it", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L123-L143
[ "def", "_prepare_lines_", "(", "self", ",", "lines", ")", ":", "result", "=", "[", "]", "for", "line", "in", "lines", ":", "# Remove all whitespace from the start and end of the line.", "line", "=", "line", ".", "strip", "(", ")", "# Replace all tabs with spaces.", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material._create_element_list_
Extract an alphabetically sorted list of elements from the compounds of the material. :returns: An alphabetically sorted list of elements.
auxi/modelling/process/materials/chem.py
def _create_element_list_(self): """ Extract an alphabetically sorted list of elements from the compounds of the material. :returns: An alphabetically sorted list of elements. """ element_set = stoich.elements(self.compounds) return sorted(list(element_set))
def _create_element_list_(self): """ Extract an alphabetically sorted list of elements from the compounds of the material. :returns: An alphabetically sorted list of elements. """ element_set = stoich.elements(self.compounds) return sorted(list(element_set))
[ "Extract", "an", "alphabetically", "sorted", "list", "of", "elements", "from", "the", "compounds", "of", "the", "material", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L145-L154
[ "def", "_create_element_list_", "(", "self", ")", ":", "element_set", "=", "stoich", ".", "elements", "(", "self", ".", "compounds", ")", "return", "sorted", "(", "list", "(", "element_set", ")", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.add_assay
Add an assay to the material. :param name: The name of the new assay. :param assay: A list containing the compound mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material's compounds.
auxi/modelling/process/materials/chem.py
def add_assay(self, name, assay): """ Add an assay to the material. :param name: The name of the new assay. :param assay: A list containing the compound mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material...
def add_assay(self, name, assay): """ Add an assay to the material. :param name: The name of the new assay. :param assay: A list containing the compound mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material...
[ "Add", "an", "assay", "to", "the", "material", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L178-L199
[ "def", "add_assay", "(", "self", ",", "name", ",", "assay", ")", ":", "if", "not", "type", "(", "assay", ")", "is", "list", ":", "raise", "Exception", "(", "'Invalid assay. It must be a list.'", ")", "elif", "not", "len", "(", "assay", ")", "==", "self",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage._is_compound_mass_tuple
Determines whether value is a tuple of the format (compound(str), mass(float)).
auxi/modelling/process/materials/chem.py
def _is_compound_mass_tuple(self, value): """ Determines whether value is a tuple of the format (compound(str), mass(float)). """ if not type(value) is tuple: return False elif not len(value) == 2: return False elif not type(value[0]) is s...
def _is_compound_mass_tuple(self, value): """ Determines whether value is a tuple of the format (compound(str), mass(float)). """ if not type(value) is tuple: return False elif not len(value) == 2: return False elif not type(value[0]) is s...
[ "Determines", "whether", "value", "is", "a", "tuple", "of", "the", "format", "(", "compound", "(", "str", ")", "mass", "(", "float", "))", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L346-L361
[ "def", "_is_compound_mass_tuple", "(", "self", ",", "value", ")", ":", "if", "not", "type", "(", "value", ")", "is", "tuple", ":", "return", "False", "elif", "not", "len", "(", "value", ")", "==", "2", ":", "return", "False", "elif", "not", "type", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.clone
Create a complete copy of self. :returns: A MaterialPackage that is identical to self.
auxi/modelling/process/materials/chem.py
def clone(self): """ Create a complete copy of self. :returns: A MaterialPackage that is identical to self. """ result = copy.copy(self) result.compound_masses = copy.deepcopy(self.compound_masses) return result
def clone(self): """ Create a complete copy of self. :returns: A MaterialPackage that is identical to self. """ result = copy.copy(self) result.compound_masses = copy.deepcopy(self.compound_masses) return result
[ "Create", "a", "complete", "copy", "of", "self", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L363-L373
[ "def", "clone", "(", "self", ")", ":", "result", "=", "copy", ".", "copy", "(", "self", ")", "result", ".", "compound_masses", "=", "copy", ".", "deepcopy", "(", "self", ".", "compound_masses", ")", "return", "result" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_assay
Determine the assay of self. :returns: [mass fractions] An array containing the assay of self.
auxi/modelling/process/materials/chem.py
def get_assay(self): """ Determine the assay of self. :returns: [mass fractions] An array containing the assay of self. """ masses_sum = sum(self.compound_masses) return [m / masses_sum for m in self.compound_masses]
def get_assay(self): """ Determine the assay of self. :returns: [mass fractions] An array containing the assay of self. """ masses_sum = sum(self.compound_masses) return [m / masses_sum for m in self.compound_masses]
[ "Determine", "the", "assay", "of", "self", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L383-L391
[ "def", "get_assay", "(", "self", ")", ":", "masses_sum", "=", "sum", "(", "self", ".", "compound_masses", ")", "return", "[", "m", "/", "masses_sum", "for", "m", "in", "self", ".", "compound_masses", "]" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_element_masses
Get the masses of elements in the package. :returns: [kg] An array of element masses. The sequence of the elements in the result corresponds with the sequence of elements in the element list of the material.
auxi/modelling/process/materials/chem.py
def get_element_masses(self): """ Get the masses of elements in the package. :returns: [kg] An array of element masses. The sequence of the elements in the result corresponds with the sequence of elements in the element list of the material. """ result = [0]...
def get_element_masses(self): """ Get the masses of elements in the package. :returns: [kg] An array of element masses. The sequence of the elements in the result corresponds with the sequence of elements in the element list of the material. """ result = [0]...
[ "Get", "the", "masses", "of", "elements", "in", "the", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L425-L440
[ "def", "get_element_masses", "(", "self", ")", ":", "result", "=", "[", "0", "]", "*", "len", "(", "self", ".", "material", ".", "elements", ")", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "c", "=", "self", ".", "get_com...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_element_mass
Determine the masses of elements in the package. :returns: [kg] An array of element masses. The sequence of the elements in the result corresponds with the sequence of elements in the element list of the material.
auxi/modelling/process/materials/chem.py
def get_element_mass(self, element): """ Determine the masses of elements in the package. :returns: [kg] An array of element masses. The sequence of the elements in the result corresponds with the sequence of elements in the element list of the material. """ ...
def get_element_mass(self, element): """ Determine the masses of elements in the package. :returns: [kg] An array of element masses. The sequence of the elements in the result corresponds with the sequence of elements in the element list of the material. """ ...
[ "Determine", "the", "masses", "of", "elements", "in", "the", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L459-L474
[ "def", "get_element_mass", "(", "self", ",", "element", ")", ":", "result", "=", "[", "0", "]", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "c", "=", "self", ".", "get_compound_mass", "(", "compound", ")", "f", "=", "[", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.extract
Extract 'other' from self, modifying self and returning the extracted material as a new package. :param other: Can be one of the following: * float: A mass equal to other is extracted from self. Self is reduced by other and the extracted package is returned as a new p...
auxi/modelling/process/materials/chem.py
def extract(self, other): """ Extract 'other' from self, modifying self and returning the extracted material as a new package. :param other: Can be one of the following: * float: A mass equal to other is extracted from self. Self is reduced by other and the extrac...
def extract(self, other): """ Extract 'other' from self, modifying self and returning the extracted material as a new package. :param other: Can be one of the following: * float: A mass equal to other is extracted from self. Self is reduced by other and the extrac...
[ "Extract", "other", "from", "self", "modifying", "self", "and", "returning", "the", "extracted", "material", "as", "a", "new", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L476-L541
[ "def", "extract", "(", "self", ",", "other", ")", ":", "# Extract the specified mass.", "if", "type", "(", "other", ")", "is", "float", ":", "if", "other", ">", "self", ".", "get_mass", "(", ")", ":", "raise", "Exception", "(", "'Invalid extraction operation...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.add_to
Add another chem material package to this material package. :param other: The other material package.
auxi/modelling/process/materials/chem.py
def add_to(self, other): """ Add another chem material package to this material package. :param other: The other material package. """ # Add another package. if type(other) is MaterialPackage: # Packages of the same material. if self.material ==...
def add_to(self, other): """ Add another chem material package to this material package. :param other: The other material package. """ # Add another package. if type(other) is MaterialPackage: # Packages of the same material. if self.material ==...
[ "Add", "another", "chem", "material", "package", "to", "this", "material", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/chem.py#L544-L582
[ "def", "add_to", "(", "self", ",", "other", ")", ":", "# Add another package.", "if", "type", "(", "other", ")", "is", "MaterialPackage", ":", "# Packages of the same material.", "if", "self", ".", "material", "==", "other", ".", "material", ":", "self", ".", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
RhoT.calculate
Calculate the density at the specified temperature. :param T: [K] temperature :returns: [kg/m3] density The **state parameter contains the keyword argument(s) specified above\ that are used to describe the state of the material.
auxi/tools/materialphysicalproperties/idealgas.py
def calculate(self, **state): """ Calculate the density at the specified temperature. :param T: [K] temperature :returns: [kg/m3] density The **state parameter contains the keyword argument(s) specified above\ that are used to describe the state of the material. ...
def calculate(self, **state): """ Calculate the density at the specified temperature. :param T: [K] temperature :returns: [kg/m3] density The **state parameter contains the keyword argument(s) specified above\ that are used to describe the state of the material. ...
[ "Calculate", "the", "density", "at", "the", "specified", "temperature", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/idealgas.py#L72-L84
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "super", "(", ")", ".", "calculate", "(", "*", "*", "state", ")", "return", "self", ".", "mm", "*", "self", ".", "P", "/", "R", "/", "state", "[", "\"T\"", "]" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
RhoTPx.calculate
Calculate the density at the specified temperature, pressure, and composition. :param T: [K] temperature :param P: [Pa] pressure :param x: [mole fraction] dictionary of compounds and mole fractions :returns: [kg/m3] density The **state parameter contains the keyword ar...
auxi/tools/materialphysicalproperties/idealgas.py
def calculate(self, **state): """ Calculate the density at the specified temperature, pressure, and composition. :param T: [K] temperature :param P: [Pa] pressure :param x: [mole fraction] dictionary of compounds and mole fractions :returns: [kg/m3] density ...
def calculate(self, **state): """ Calculate the density at the specified temperature, pressure, and composition. :param T: [K] temperature :param P: [Pa] pressure :param x: [mole fraction] dictionary of compounds and mole fractions :returns: [kg/m3] density ...
[ "Calculate", "the", "density", "at", "the", "specified", "temperature", "pressure", "and", "composition", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/idealgas.py#L167-L187
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "super", "(", ")", ".", "calculate", "(", "*", "*", "state", ")", "mm_average", "=", "0.0", "for", "compound", ",", "molefraction", "in", "state", "[", "\"x\"", "]", ".", "items", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerAccount.set_parent_path
Set the parent path and the path from the new parent path. :param value: The path to the object's parent
auxi/modelling/financial/des.py
def set_parent_path(self, value): """ Set the parent path and the path from the new parent path. :param value: The path to the object's parent """ self._parent_path = value self.path = value + r'/' + self.name self._update_childrens_parent_path()
def set_parent_path(self, value): """ Set the parent path and the path from the new parent path. :param value: The path to the object's parent """ self._parent_path = value self.path = value + r'/' + self.name self._update_childrens_parent_path()
[ "Set", "the", "parent", "path", "and", "the", "path", "from", "the", "new", "parent", "path", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L64-L73
[ "def", "set_parent_path", "(", "self", ",", "value", ")", ":", "self", ".", "_parent_path", "=", "value", "self", ".", "path", "=", "value", "+", "r'/'", "+", "self", ".", "name", "self", ".", "_update_childrens_parent_path", "(", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerAccount.create_account
Create a sub account in the account. :param name: The account name. :param description: The account description. :param number: The account number. :returns: The created account.
auxi/modelling/financial/des.py
def create_account(self, name, number=None, description=None): """ Create a sub account in the account. :param name: The account name. :param description: The account description. :param number: The account number. :returns: The created account. """ new...
def create_account(self, name, number=None, description=None): """ Create a sub account in the account. :param name: The account name. :param description: The account description. :param number: The account number. :returns: The created account. """ new...
[ "Create", "a", "sub", "account", "in", "the", "account", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L92-L107
[ "def", "create_account", "(", "self", ",", "name", ",", "number", "=", "None", ",", "description", "=", "None", ")", ":", "new_account", "=", "GeneralLedgerAccount", "(", "name", ",", "description", ",", "number", ",", "self", ".", "account_type", ")", "ne...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerAccount.remove_account
Remove an account from the account's sub accounts. :param name: The name of the account to remove.
auxi/modelling/financial/des.py
def remove_account(self, name): """ Remove an account from the account's sub accounts. :param name: The name of the account to remove. """ acc_to_remove = None for a in self.accounts: if a.name == name: acc_to_remove = a if acc_to_rem...
def remove_account(self, name): """ Remove an account from the account's sub accounts. :param name: The name of the account to remove. """ acc_to_remove = None for a in self.accounts: if a.name == name: acc_to_remove = a if acc_to_rem...
[ "Remove", "an", "account", "from", "the", "account", "s", "sub", "accounts", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L109-L121
[ "def", "remove_account", "(", "self", ",", "name", ")", ":", "acc_to_remove", "=", "None", "for", "a", "in", "self", ".", "accounts", ":", "if", "a", ".", "name", "==", "name", ":", "acc_to_remove", "=", "a", "if", "acc_to_remove", "is", "not", "None",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerAccount.get_child_account
Retrieves a child account. This could be a descendant nested at any level. :param account_name: The name of the account to retrieve. :returns: The child account, if found, else None.
auxi/modelling/financial/des.py
def get_child_account(self, account_name): """ Retrieves a child account. This could be a descendant nested at any level. :param account_name: The name of the account to retrieve. :returns: The child account, if found, else None. """ if r'/' in account_name: ...
def get_child_account(self, account_name): """ Retrieves a child account. This could be a descendant nested at any level. :param account_name: The name of the account to retrieve. :returns: The child account, if found, else None. """ if r'/' in account_name: ...
[ "Retrieves", "a", "child", "account", ".", "This", "could", "be", "a", "descendant", "nested", "at", "any", "level", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L123-L142
[ "def", "get_child_account", "(", "self", ",", "account_name", ")", ":", "if", "r'/'", "in", "account_name", ":", "accs_in_path", "=", "account_name", ".", "split", "(", "r'/'", ",", "1", ")", "curr_acc", "=", "self", "[", "accs_in_path", "[", "0", "]", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerStructure._create_account_
Create an account in the general ledger structure. :param name: The account name. :param number: The account number. :param account_type: The account type. :returns: The created account.
auxi/modelling/financial/des.py
def _create_account_(self, name, number, account_type): """ Create an account in the general ledger structure. :param name: The account name. :param number: The account number. :param account_type: The account type. :returns: The created account. """ ne...
def _create_account_(self, name, number, account_type): """ Create an account in the general ledger structure. :param name: The account name. :param number: The account number. :param account_type: The account type. :returns: The created account. """ ne...
[ "Create", "an", "account", "in", "the", "general", "ledger", "structure", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L264-L277
[ "def", "_create_account_", "(", "self", ",", "name", ",", "number", ",", "account_type", ")", ":", "new_acc", "=", "GeneralLedgerAccount", "(", "name", ",", "None", ",", "number", ",", "account_type", ")", "self", ".", "accounts", ".", "append", "(", "new_...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerStructure.get_account_descendants
Retrieves an account's descendants from the general ledger structure given the account name. :param account_name: The account name. :returns: The decendants of the account.
auxi/modelling/financial/des.py
def get_account_descendants(self, account): """ Retrieves an account's descendants from the general ledger structure given the account name. :param account_name: The account name. :returns: The decendants of the account. """ result = [] for child in acc...
def get_account_descendants(self, account): """ Retrieves an account's descendants from the general ledger structure given the account name. :param account_name: The account name. :returns: The decendants of the account. """ result = [] for child in acc...
[ "Retrieves", "an", "account", "s", "descendants", "from", "the", "general", "ledger", "structure", "given", "the", "account", "name", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L300-L313
[ "def", "get_account_descendants", "(", "self", ",", "account", ")", ":", "result", "=", "[", "]", "for", "child", "in", "account", ".", "accounts", ":", "self", ".", "_get_account_and_descendants_", "(", "child", ",", "result", ")", "return", "result" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerStructure._get_account_and_descendants_
Returns the account and all of it's sub accounts. :param account: The account. :param result: The list to add all the accounts to.
auxi/modelling/financial/des.py
def _get_account_and_descendants_(self, account, result): """ Returns the account and all of it's sub accounts. :param account: The account. :param result: The list to add all the accounts to. """ result.append(account) for child in account.accounts: ...
def _get_account_and_descendants_(self, account, result): """ Returns the account and all of it's sub accounts. :param account: The account. :param result: The list to add all the accounts to. """ result.append(account) for child in account.accounts: ...
[ "Returns", "the", "account", "and", "all", "of", "it", "s", "sub", "accounts", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L315-L325
[ "def", "_get_account_and_descendants_", "(", "self", ",", "account", ",", "result", ")", ":", "result", ".", "append", "(", "account", ")", "for", "child", "in", "account", ".", "accounts", ":", "self", ".", "_get_account_and_descendants_", "(", "child", ",", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerStructure.validate_account_names
Validates whether the accounts in a list of account names exists. :param names: The names of the accounts. :returns: The descendants of the account.
auxi/modelling/financial/des.py
def validate_account_names(self, names): """ Validates whether the accounts in a list of account names exists. :param names: The names of the accounts. :returns: The descendants of the account. """ for name in names: if self.get_account(name) is None: ...
def validate_account_names(self, names): """ Validates whether the accounts in a list of account names exists. :param names: The names of the accounts. :returns: The descendants of the account. """ for name in names: if self.get_account(name) is None: ...
[ "Validates", "whether", "the", "accounts", "in", "a", "list", "of", "account", "names", "exists", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L327-L339
[ "def", "validate_account_names", "(", "self", ",", "names", ")", ":", "for", "name", "in", "names", ":", "if", "self", ".", "get_account", "(", "name", ")", "is", "None", ":", "raise", "ValueError", "(", "\"The account '{}' does not exist in the\"", "\" general...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedgerStructure.report
Returns a report of this class. :param format: The format of the report. :param output_path: The path to the file the report is written to. If None, then the report is not written to a file. :returns: The descendants of the account.
auxi/modelling/financial/des.py
def report(self, format=ReportFormat.printout, output_path=None): """ Returns a report of this class. :param format: The format of the report. :param output_path: The path to the file the report is written to. If None, then the report is not written to a file. :return...
def report(self, format=ReportFormat.printout, output_path=None): """ Returns a report of this class. :param format: The format of the report. :param output_path: The path to the file the report is written to. If None, then the report is not written to a file. :return...
[ "Returns", "a", "report", "of", "this", "class", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L341-L353
[ "def", "report", "(", "self", ",", "format", "=", "ReportFormat", ".", "printout", ",", "output_path", "=", "None", ")", ":", "rpt", "=", "GlsRpt", "(", "self", ",", "output_path", ")", "return", "rpt", ".", "render", "(", "format", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedger.create_transaction
Create a transaction in the general ledger. :param name: The transaction's name. :param description: The transaction's description. :param tx_date: The date of the transaction. :param cr_account: The transaction's credit account's name. :param dt_account: The transaction's debit...
auxi/modelling/financial/des.py
def create_transaction(self, name, description=None, tx_date=datetime.min.date(), dt_account=None, cr_account=None, source=None, amount=0.00): """ Create a transaction in the general ledger. :param name: The transa...
def create_transaction(self, name, description=None, tx_date=datetime.min.date(), dt_account=None, cr_account=None, source=None, amount=0.00): """ Create a transaction in the general ledger. :param name: The transa...
[ "Create", "a", "transaction", "in", "the", "general", "ledger", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L370-L391
[ "def", "create_transaction", "(", "self", ",", "name", ",", "description", "=", "None", ",", "tx_date", "=", "datetime", ".", "min", ".", "date", "(", ")", ",", "dt_account", "=", "None", ",", "cr_account", "=", "None", ",", "source", "=", "None", ",",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedger.transaction_list
Generate a transaction list report. :param start: The start date to generate the report for. :param end: The end date to generate the report for. :param format: The format of the report. :param component_path: The path of the component to filter the report's transactions by. ...
auxi/modelling/financial/des.py
def transaction_list(self, start=datetime.min, end=datetime.max, format=ReportFormat.printout, component_path="", output_path=None): """ Generate a transaction list report. :param start: The star...
def transaction_list(self, start=datetime.min, end=datetime.max, format=ReportFormat.printout, component_path="", output_path=None): """ Generate a transaction list report. :param start: The star...
[ "Generate", "a", "transaction", "list", "report", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L393-L413
[ "def", "transaction_list", "(", "self", ",", "start", "=", "datetime", ".", "min", ",", "end", "=", "datetime", ".", "max", ",", "format", "=", "ReportFormat", ".", "printout", ",", "component_path", "=", "\"\"", ",", "output_path", "=", "None", ")", ":"...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedger.balance_sheet
Generate a transaction list report. :param end: The end date to generate the report for. :param format: The format of the report. :param output_path: The path to the file the report is written to. If None, then the report is not written to a file. :returns: The generated repo...
auxi/modelling/financial/des.py
def balance_sheet(self, end=datetime.max, format=ReportFormat.printout, output_path=None): """ Generate a transaction list report. :param end: The end date to generate the report for. :param format: The format of the report. :param output_path: The path to ...
def balance_sheet(self, end=datetime.max, format=ReportFormat.printout, output_path=None): """ Generate a transaction list report. :param end: The end date to generate the report for. :param format: The format of the report. :param output_path: The path to ...
[ "Generate", "a", "transaction", "list", "report", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L415-L429
[ "def", "balance_sheet", "(", "self", ",", "end", "=", "datetime", ".", "max", ",", "format", "=", "ReportFormat", ".", "printout", ",", "output_path", "=", "None", ")", ":", "rpt", "=", "BalanceSheet", "(", "self", ",", "end", ",", "output_path", ")", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
GeneralLedger.income_statement
Generate a transaction list report. :param start: The start date to generate the report for. :param end: The end date to generate the report for. :param format: The format of the report. :param component_path: The path of the component to filter the report's transactions by. ...
auxi/modelling/financial/des.py
def income_statement(self, start=datetime.min, end=datetime.max, format=ReportFormat.printout, component_path="", output_path=None): """ Generate a transaction list report. :param start: The star...
def income_statement(self, start=datetime.min, end=datetime.max, format=ReportFormat.printout, component_path="", output_path=None): """ Generate a transaction list report. :param start: The star...
[ "Generate", "a", "transaction", "list", "report", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/financial/des.py#L431-L451
[ "def", "income_statement", "(", "self", ",", "start", "=", "datetime", ".", "min", ",", "end", "=", "datetime", ".", "max", ",", "format", "=", "ReportFormat", ".", "printout", ",", "component_path", "=", "\"\"", ",", "output_path", "=", "None", ")", ":"...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
get_path_relative_to_module
Calculate a path relative to the specified module file. :param module_file_path: The file path to the module.
auxi/core/helpers.py
def get_path_relative_to_module(module_file_path, relative_target_path): """ Calculate a path relative to the specified module file. :param module_file_path: The file path to the module. """ module_path = os.path.dirname(module_file_path) path = os.path.join(module_path, relative_target_path) ...
def get_path_relative_to_module(module_file_path, relative_target_path): """ Calculate a path relative to the specified module file. :param module_file_path: The file path to the module. """ module_path = os.path.dirname(module_file_path) path = os.path.join(module_path, relative_target_path) ...
[ "Calculate", "a", "path", "relative", "to", "the", "specified", "module", "file", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/core/helpers.py#L11-L20
[ "def", "get_path_relative_to_module", "(", "module_file_path", ",", "relative_target_path", ")", ":", "module_path", "=", "os", ".", "path", ".", "dirname", "(", "module_file_path", ")", "path", "=", "os", ".", "path", ".", "join", "(", "module_path", ",", "re...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
get_date
Get the date from a value that could be a date object or a string. :param date: The date object or string. :returns: The date object.
auxi/core/helpers.py
def get_date(date): """ Get the date from a value that could be a date object or a string. :param date: The date object or string. :returns: The date object. """ if type(date) is str: return datetime.strptime(date, '%Y-%m-%d').date() else: return date
def get_date(date): """ Get the date from a value that could be a date object or a string. :param date: The date object or string. :returns: The date object. """ if type(date) is str: return datetime.strptime(date, '%Y-%m-%d').date() else: return date
[ "Get", "the", "date", "from", "a", "value", "that", "could", "be", "a", "date", "object", "or", "a", "string", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/core/helpers.py#L23-L34
[ "def", "get_date", "(", "date", ")", ":", "if", "type", "(", "date", ")", "is", "str", ":", "return", "datetime", ".", "strptime", "(", "date", ",", "'%Y-%m-%d'", ")", ".", "date", "(", ")", "else", ":", "return", "date" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
f_tr_Haaland
Calculate the friction factor of turbulent flow (t) in a rough duct (r) for the provided conditions with Haaland's equation. :param Re_D: Reynolds number for the specified hydraulic diameter. :param ɛ: [m] Surface roughness. :param D: [m] Duct hydraulic diameter. :return: Friction factor. Sour...
auxi/tools/transportphenomena/fluidflow/pressuredrop.py
def f_tr_Haaland(Re_D, ɛ, D, warn=True): """ Calculate the friction factor of turbulent flow (t) in a rough duct (r) for the provided conditions with Haaland's equation. :param Re_D: Reynolds number for the specified hydraulic diameter. :param ɛ: [m] Surface roughness. :param D: [m] Duct hydrau...
def f_tr_Haaland(Re_D, ɛ, D, warn=True): """ Calculate the friction factor of turbulent flow (t) in a rough duct (r) for the provided conditions with Haaland's equation. :param Re_D: Reynolds number for the specified hydraulic diameter. :param ɛ: [m] Surface roughness. :param D: [m] Duct hydrau...
[ "Calculate", "the", "friction", "factor", "of", "turbulent", "flow", "(", "t", ")", "in", "a", "rough", "duct", "(", "r", ")", "for", "the", "provided", "conditions", "with", "Haaland", "s", "equation", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/fluidflow/pressuredrop.py#L50-L80
[ "def", "f_tr_Haaland", "(", "Re_D", ",", "ɛ,", " ", ",", " ", "arn=", "T", "rue)", ":", "", "if", "warn", ":", "try", ":", "if", "(", "ɛ ", " ", ")", " ", " ", ".0 ", "r ", "ɛ", " /", "D", " ", ">", "0", "05:", "", "raise", "Warning", "(", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
IsothermalFlatSurface.Nu_x
Calculate the local Nusselt number. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf: [K] bulk fluid temperature :returns: float
auxi/tools/transportphenomena/heattransfer/naturalconvection.py
def Nu_x(self, L, theta, Ts, **statef): """ Calculate the local Nusselt number. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf: [K] bulk ...
def Nu_x(self, L, theta, Ts, **statef): """ Calculate the local Nusselt number. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf: [K] bulk ...
[ "Calculate", "the", "local", "Nusselt", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/heattransfer/naturalconvection.py#L283-L326
[ "def", "Nu_x", "(", "self", ",", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", ":", "Tf", "=", "statef", "[", "'T'", "]", "thetar", "=", "radians", "(", "theta", ")", "if", "self", ".", "_isgas", ":", "self", ".", "Tr", "=", "Ts...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
IsothermalFlatSurface.Nu_L
Calculate the average Nusselt number. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param **statef: [K] bulk fluid temperature :returns: float
auxi/tools/transportphenomena/heattransfer/naturalconvection.py
def Nu_L(self, L, theta, Ts, **statef): """ Calculate the average Nusselt number. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param **statef: [...
def Nu_L(self, L, theta, Ts, **statef): """ Calculate the average Nusselt number. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param **statef: [...
[ "Calculate", "the", "average", "Nusselt", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/heattransfer/naturalconvection.py#L328-L340
[ "def", "Nu_L", "(", "self", ",", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", ":", "return", "self", ".", "Nu_x", "(", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", "/", "0.75" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
IsothermalFlatSurface.h_x
Calculate the local heat transfer coefficient. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf: [K] bulk fluid temperature :returns: [W/m2/K] flo...
auxi/tools/transportphenomena/heattransfer/naturalconvection.py
def h_x(self, L, theta, Ts, **statef): """ Calculate the local heat transfer coefficient. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf:...
def h_x(self, L, theta, Ts, **statef): """ Calculate the local heat transfer coefficient. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf:...
[ "Calculate", "the", "local", "heat", "transfer", "coefficient", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/heattransfer/naturalconvection.py#L342-L356
[ "def", "h_x", "(", "self", ",", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", ":", "Nu_x", "=", "self", ".", "Nu_x", "(", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", "k", "=", "self", ".", "_fluid", ".", "k", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
IsothermalFlatSurface.h_L
Calculate the average heat transfer coefficient. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param Tf: [K] bulk fluid temperature :returns: [W/m2/K] f...
auxi/tools/transportphenomena/heattransfer/naturalconvection.py
def h_L(self, L, theta, Ts, **statef): """ Calculate the average heat transfer coefficient. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param T...
def h_L(self, L, theta, Ts, **statef): """ Calculate the average heat transfer coefficient. :param L: [m] characteristic length of the heat transfer surface :param theta: [°] angle of the surface with the vertical :param Ts: [K] heat transfer surface temperature :param T...
[ "Calculate", "the", "average", "heat", "transfer", "coefficient", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/heattransfer/naturalconvection.py#L358-L372
[ "def", "h_L", "(", "self", ",", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", ":", "Nu_L", "=", "self", ".", "Nu_L", "(", "L", ",", "theta", ",", "Ts", ",", "*", "*", "statef", ")", "k", "=", "self", ".", "_fluid", ".", "k", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material._prepare_lines
Prepare the lines read from the text file before starting to process it.
auxi/modelling/process/materials/slurry.py
def _prepare_lines(self, lines): """ Prepare the lines read from the text file before starting to process it. """ result = list() for line in lines: # Remove all whitespace characters (e.g. spaces, line breaks, etc.) # from the start and end of th...
def _prepare_lines(self, lines): """ Prepare the lines read from the text file before starting to process it. """ result = list() for line in lines: # Remove all whitespace characters (e.g. spaces, line breaks, etc.) # from the start and end of th...
[ "Prepare", "the", "lines", "read", "from", "the", "text", "file", "before", "starting", "to", "process", "it", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/slurry.py#L176-L193
[ "def", "_prepare_lines", "(", "self", ",", "lines", ")", ":", "result", "=", "list", "(", ")", "for", "line", "in", "lines", ":", "# Remove all whitespace characters (e.g. spaces, line breaks, etc.)", "# from the start and end of the line.", "line", "=", "line", ".", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.add_assay
Add an assay to the material. :param name: The name of the new assay. :param assay: A numpy array containing the size class mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material's size classes.
auxi/modelling/process/materials/slurry.py
def add_assay(self, name, solid_density, H2O_fraction, assay): """Add an assay to the material. :param name: The name of the new assay. :param assay: A numpy array containing the size class mass fractions for the assay. The sequence of the assay's elements must correspond to...
def add_assay(self, name, solid_density, H2O_fraction, assay): """Add an assay to the material. :param name: The name of the new assay. :param assay: A numpy array containing the size class mass fractions for the assay. The sequence of the assay's elements must correspond to...
[ "Add", "an", "assay", "to", "the", "material", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/slurry.py#L230-L256
[ "def", "add_assay", "(", "self", ",", "name", ",", "solid_density", ",", "H2O_fraction", ",", "assay", ")", ":", "if", "not", "type", "(", "solid_density", ")", "is", "float", ":", "raise", "Exception", "(", "\"Invalid solid density. It must be a float.\"", ")",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.create_package
Create a MaterialPackage based on the specified parameters. :param assay: The name of the assay based on which the package must be created. :param mass: [kg] The mass of the package. :param normalise: Indicates whether the assay must be normalised before creating the package...
auxi/modelling/process/materials/slurry.py
def create_package(self, assay=None, mass=0.0, normalise=True): """ Create a MaterialPackage based on the specified parameters. :param assay: The name of the assay based on which the package must be created. :param mass: [kg] The mass of the package. :param normalise: ...
def create_package(self, assay=None, mass=0.0, normalise=True): """ Create a MaterialPackage based on the specified parameters. :param assay: The name of the assay based on which the package must be created. :param mass: [kg] The mass of the package. :param normalise: ...
[ "Create", "a", "MaterialPackage", "based", "on", "the", "specified", "parameters", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/slurry.py#L281-L308
[ "def", "create_package", "(", "self", ",", "assay", "=", "None", ",", "mass", "=", "0.0", ",", "normalise", "=", "True", ")", ":", "if", "assay", "is", "None", ":", "return", "MaterialPackage", "(", "self", ",", "1.0", ",", "0.0", ",", "self", ".", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage._is_size_class_mass_tuple
Determines whether value is a tuple of the format (size class(float), mass(float)). :param value: The value to check. :returns: Whether the value is a tuple in the required format.
auxi/modelling/process/materials/slurry.py
def _is_size_class_mass_tuple(self, value): """ Determines whether value is a tuple of the format (size class(float), mass(float)). :param value: The value to check. :returns: Whether the value is a tuple in the required format. """ if not type(value) is tuple:...
def _is_size_class_mass_tuple(self, value): """ Determines whether value is a tuple of the format (size class(float), mass(float)). :param value: The value to check. :returns: Whether the value is a tuple in the required format. """ if not type(value) is tuple:...
[ "Determines", "whether", "value", "is", "a", "tuple", "of", "the", "format", "(", "size", "class", "(", "float", ")", "mass", "(", "float", "))", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/slurry.py#L464-L485
[ "def", "_is_size_class_mass_tuple", "(", "self", ",", "value", ")", ":", "if", "not", "type", "(", "value", ")", "is", "tuple", ":", "return", "False", "elif", "not", "len", "(", "value", ")", "==", "2", ":", "return", "False", "elif", "not", "type", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.clone
Create a complete copy of self. :returns: A MaterialPackage that is identical to self.
auxi/modelling/process/materials/slurry.py
def clone(self): """ Create a complete copy of self. :returns: A MaterialPackage that is identical to self. """ result = copy.copy(self) result.size_class_masses = copy.deepcopy(self.size_class_masses) return result
def clone(self): """ Create a complete copy of self. :returns: A MaterialPackage that is identical to self. """ result = copy.copy(self) result.size_class_masses = copy.deepcopy(self.size_class_masses) return result
[ "Create", "a", "complete", "copy", "of", "self", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/slurry.py#L510-L519
[ "def", "clone", "(", "self", ")", ":", "result", "=", "copy", ".", "copy", "(", "self", ")", "result", ".", "size_class_masses", "=", "copy", ".", "deepcopy", "(", "self", ".", "size_class_masses", ")", "return", "result" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.clear
Set all the size class masses and H20_mass in the package to zero and the solid_density to 1.0
auxi/modelling/process/materials/slurry.py
def clear(self): """ Set all the size class masses and H20_mass in the package to zero and the solid_density to 1.0 """ self.solid_density = 1.0 self.H2O_mass = 0.0 self.size_class_masses = self.size_class_masses * 0.0
def clear(self): """ Set all the size class masses and H20_mass in the package to zero and the solid_density to 1.0 """ self.solid_density = 1.0 self.H2O_mass = 0.0 self.size_class_masses = self.size_class_masses * 0.0
[ "Set", "all", "the", "size", "class", "masses", "and", "H20_mass", "in", "the", "package", "to", "zero", "and", "the", "solid_density", "to", "1", ".", "0" ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/slurry.py#L521-L529
[ "def", "clear", "(", "self", ")", ":", "self", ".", "solid_density", "=", "1.0", "self", ".", "H2O_mass", "=", "0.0", "self", ".", "size_class_masses", "=", "self", ".", "size_class_masses", "*", "0.0" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
DataSet.create_template
Create a template csv file for a data set. :param material: the name of the material :param path: the path of the directory where the file must be written :param show: a boolean indicating whether the created file should be \ displayed after creation
auxi/tools/materialphysicalproperties/core.py
def create_template(material, path, show=False): """ Create a template csv file for a data set. :param material: the name of the material :param path: the path of the directory where the file must be written :param show: a boolean indicating whether the created file should be \ ...
def create_template(material, path, show=False): """ Create a template csv file for a data set. :param material: the name of the material :param path: the path of the directory where the file must be written :param show: a boolean indicating whether the created file should be \ ...
[ "Create", "a", "template", "csv", "file", "for", "a", "data", "set", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/core.py#L53-L86
[ "def", "create_template", "(", "material", ",", "path", ",", "show", "=", "False", ")", ":", "file_name", "=", "'dataset-%s.csv'", "%", "material", ".", "lower", "(", ")", "file_path", "=", "os", ".", "path", ".", "join", "(", "path", ",", "file_name", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Model.calculate
Base calculate method for models. Validates the material state parameter(s). :param **state: The material state
auxi/tools/materialphysicalproperties/core.py
def calculate(self, **state): """ Base calculate method for models. Validates the material state parameter(s). :param **state: The material state """ if not self.state_validator.validate(state): msg = f"{self.material} {self.property} model. The state " ...
def calculate(self, **state): """ Base calculate method for models. Validates the material state parameter(s). :param **state: The material state """ if not self.state_validator.validate(state): msg = f"{self.material} {self.property} model. The state " ...
[ "Base", "calculate", "method", "for", "models", ".", "Validates", "the", "material", "state", "parameter", "(", "s", ")", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/core.py#L190-L203
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "if", "not", "self", ".", "state_validator", ".", "validate", "(", "state", ")", ":", "msg", "=", "f\"{self.material} {self.property} model. The state \"", "msg", "+=", "f\"description ({state}) co...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Api.delete
Returns the response and body for a delete request endpoints = 'users' # resource to access data = {'username': 'blah, 'password': blah} # DELETE body url_data = {}, () # Used to modularize endpoints, see __init__ parameters = {}, ((),()) # URL paramters, ex: google.co...
api.py
def delete(self, endpoint, data, url_data=None, parameters=None): """Returns the response and body for a delete request endpoints = 'users' # resource to access data = {'username': 'blah, 'password': blah} # DELETE body url_data = {}, () # Used to modularize endpoints, see...
def delete(self, endpoint, data, url_data=None, parameters=None): """Returns the response and body for a delete request endpoints = 'users' # resource to access data = {'username': 'blah, 'password': blah} # DELETE body url_data = {}, () # Used to modularize endpoints, see...
[ "Returns", "the", "response", "and", "body", "for", "a", "delete", "request", "endpoints", "=", "users", "#", "resource", "to", "access", "data", "=", "{", "username", ":", "blah", "password", ":", "blah", "}", "#", "DELETE", "body", "url_data", "=", "{}...
travisby/pyrest
python
https://github.com/travisby/pyrest/blob/1bd625028aa0c2b901f27e1a8ef0a45d12404830/api.py#L106-L117
[ "def", "delete", "(", "self", ",", "endpoint", ",", "data", ",", "url_data", "=", "None", ",", "parameters", "=", "None", ")", ":", "return", "self", ".", "request_handler", ".", "request", "(", "self", ".", "_url", "(", "endpoint", ",", "url_data", ",...
1bd625028aa0c2b901f27e1a8ef0a45d12404830
valid
Api.head
Returns the response and body for a head request endpoints = 'users' # resource to access url_data = {}, () # Used to modularize endpoints, see __init__ parameters = {}, ((),()) # URL paramters, ex: google.com?q=a&f=b
api.py
def head(self, endpoint, url_data=None, parameters=None): """Returns the response and body for a head request endpoints = 'users' # resource to access url_data = {}, () # Used to modularize endpoints, see __init__ parameters = {}, ((),()) # URL paramters, ex: google.com?q=a...
def head(self, endpoint, url_data=None, parameters=None): """Returns the response and body for a head request endpoints = 'users' # resource to access url_data = {}, () # Used to modularize endpoints, see __init__ parameters = {}, ((),()) # URL paramters, ex: google.com?q=a...
[ "Returns", "the", "response", "and", "body", "for", "a", "head", "request", "endpoints", "=", "users", "#", "resource", "to", "access", "url_data", "=", "{}", "()", "#", "Used", "to", "modularize", "endpoints", "see", "__init__", "parameters", "=", "{}", "...
travisby/pyrest
python
https://github.com/travisby/pyrest/blob/1bd625028aa0c2b901f27e1a8ef0a45d12404830/api.py#L119-L128
[ "def", "head", "(", "self", ",", "endpoint", ",", "url_data", "=", "None", ",", "parameters", "=", "None", ")", ":", "return", "self", ".", "request_handler", ".", "request", "(", "self", ".", "_url", "(", "endpoint", ",", "url_data", ",", "parameters", ...
1bd625028aa0c2b901f27e1a8ef0a45d12404830
valid
Api._url
Generate URL on the modularized endpoints and url parameters
api.py
def _url(self, endpoint, url_data=None, parameters=None): """Generate URL on the modularized endpoints and url parameters""" try: url = '%s/%s' % (self.base_url, self.endpoints[endpoint]) except KeyError: raise EndPointDoesNotExist(endpoint) if url_data: ...
def _url(self, endpoint, url_data=None, parameters=None): """Generate URL on the modularized endpoints and url parameters""" try: url = '%s/%s' % (self.base_url, self.endpoints[endpoint]) except KeyError: raise EndPointDoesNotExist(endpoint) if url_data: ...
[ "Generate", "URL", "on", "the", "modularized", "endpoints", "and", "url", "parameters" ]
travisby/pyrest
python
https://github.com/travisby/pyrest/blob/1bd625028aa0c2b901f27e1a8ef0a45d12404830/api.py#L130-L141
[ "def", "_url", "(", "self", ",", "endpoint", ",", "url_data", "=", "None", ",", "parameters", "=", "None", ")", ":", "try", ":", "url", "=", "'%s/%s'", "%", "(", "self", ".", "base_url", ",", "self", ".", "endpoints", "[", "endpoint", "]", ")", "ex...
1bd625028aa0c2b901f27e1a8ef0a45d12404830
valid
Api._httplib2_init
Used to instantiate a regular HTTP request object
api.py
def _httplib2_init(username, password): """Used to instantiate a regular HTTP request object""" obj = httplib2.Http() if username and password: obj.add_credentials(username, password) return obj
def _httplib2_init(username, password): """Used to instantiate a regular HTTP request object""" obj = httplib2.Http() if username and password: obj.add_credentials(username, password) return obj
[ "Used", "to", "instantiate", "a", "regular", "HTTP", "request", "object" ]
travisby/pyrest
python
https://github.com/travisby/pyrest/blob/1bd625028aa0c2b901f27e1a8ef0a45d12404830/api.py#L144-L149
[ "def", "_httplib2_init", "(", "username", ",", "password", ")", ":", "obj", "=", "httplib2", ".", "Http", "(", ")", "if", "username", "and", "password", ":", "obj", ".", "add_credentials", "(", "username", ",", "password", ")", "return", "obj" ]
1bd625028aa0c2b901f27e1a8ef0a45d12404830
valid
UrbainViscosityTx.calculate
Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param x: [mole fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s] dynamic viscosity The **state parameter ...
auxi/tools/materialphysicalproperties/slags.py
def calculate(self, **state): """ Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param x: [mole fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s]...
def calculate(self, **state): """ Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param x: [mole fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s]...
[ "Calculate", "dynamic", "viscosity", "at", "the", "specified", "temperature", "and", "composition", ":" ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/slags.py#L43-L94
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "T", "=", "state", "[", "'T'", "]", "x", "=", "state", "[", "'x'", "]", "# normalise mole fractions", "x_total", "=", "sum", "(", "x", ".", "values", "(", ")", ")", "x", "=", "{",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
UrbainViscosityTy.calculate
Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param y: [mass fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s] dynamic viscosity The **state parameter ...
auxi/tools/materialphysicalproperties/slags.py
def calculate(self, **state): """ Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param y: [mass fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s]...
def calculate(self, **state): """ Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param y: [mass fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s]...
[ "Calculate", "dynamic", "viscosity", "at", "the", "specified", "temperature", "and", "composition", ":" ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/slags.py#L110-L128
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "T", "=", "state", "[", "'T'", "]", "y", "=", "state", "[", "'y'", "]", "x", "=", "amount_fractions", "(", "y", ")", "return", "super", "(", ")", ".", "calculate", "(", "T", "="...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
RiboudViscosityTx.calculate
Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param x: [mole fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s] dynamic viscosity The **state parameter ...
auxi/tools/materialphysicalproperties/slags.py
def calculate(self, **state): """ Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param x: [mole fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s]...
def calculate(self, **state): """ Calculate dynamic viscosity at the specified temperature and composition: :param T: [K] temperature :param x: [mole fraction] composition dictionary , e.g. \ {'SiO2': 0.25, 'CaO': 0.25, 'MgO': 0.25, 'FeO': 0.25} :returns: [Pa.s]...
[ "Calculate", "dynamic", "viscosity", "at", "the", "specified", "temperature", "and", "composition", ":" ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/slags.py#L144-L196
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "T", "=", "state", "[", "'T'", "]", "x", "=", "state", "[", "'x'", "]", "# create the slag constituent categories", "compounds_sio2", "=", "[", "'SiO2'", ",", "'PO2.5'", ",", "'TiO2'", ",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.alpha
Calculate the alpha value given the material state. :param **state: material state :returns: float
auxi/modelling/process/materials/core.py
def alpha(self, **state): """ Calculate the alpha value given the material state. :param **state: material state :returns: float """ return self.k(**state) / self.rho(**state) / self.Cp(**state)
def alpha(self, **state): """ Calculate the alpha value given the material state. :param **state: material state :returns: float """ return self.k(**state) / self.rho(**state) / self.Cp(**state)
[ "Calculate", "the", "alpha", "value", "given", "the", "material", "state", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/core.py#L59-L68
[ "def", "alpha", "(", "self", ",", "*", "*", "state", ")", ":", "return", "self", ".", "k", "(", "*", "*", "state", ")", "/", "self", ".", "rho", "(", "*", "*", "state", ")", "/", "self", ".", "Cp", "(", "*", "*", "state", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
DafThermoTy._calc_a
Calculate the mean atomic weight for the specified element mass fractions. :param y_C: Carbon mass fraction :param y_H: Hydrogen mass fraction :param y_O: Oxygen mass fraction :param y_N: Nitrogen mass fraction :param y_S: Sulphur mass fraction :r...
auxi/tools/materialphysicalproperties/coals.py
def _calc_a(self, y_C, y_H, y_O, y_N, y_S): """ Calculate the mean atomic weight for the specified element mass fractions. :param y_C: Carbon mass fraction :param y_H: Hydrogen mass fraction :param y_O: Oxygen mass fraction :param y_N: Nitrogen mass fract...
def _calc_a(self, y_C, y_H, y_O, y_N, y_S): """ Calculate the mean atomic weight for the specified element mass fractions. :param y_C: Carbon mass fraction :param y_H: Hydrogen mass fraction :param y_O: Oxygen mass fraction :param y_N: Nitrogen mass fract...
[ "Calculate", "the", "mean", "atomic", "weight", "for", "the", "specified", "element", "mass", "fractions", ".", ":", "param", "y_C", ":", "Carbon", "mass", "fraction", ":", "param", "y_H", ":", "Hydrogen", "mass", "fraction", ":", "param", "y_O", ":", "Oxy...
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/coals.py#L54-L71
[ "def", "_calc_a", "(", "self", ",", "y_C", ",", "y_H", ",", "y_O", ",", "y_N", ",", "y_S", ")", ":", "return", "1", "/", "(", "y_C", "/", "mm", "(", "\"C\"", ")", "+", "y_H", "/", "mm", "(", "\"H\"", ")", "+", "y_O", "/", "mm", "(", "\"O\""...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
DafHTy.calculate
Calculate the enthalpy at the specified temperature and composition using equation 9 in Merrick1983b. :param T: [K] temperature :param y_C: Carbon mass fraction :param y_H: Hydrogen mass fraction :param y_O: Oxygen mass fraction :param y_N: Nitrogen mass fraction ...
auxi/tools/materialphysicalproperties/coals.py
def calculate(self, **state): """ Calculate the enthalpy at the specified temperature and composition using equation 9 in Merrick1983b. :param T: [K] temperature :param y_C: Carbon mass fraction :param y_H: Hydrogen mass fraction :param y_O: Oxygen mass fraction ...
def calculate(self, **state): """ Calculate the enthalpy at the specified temperature and composition using equation 9 in Merrick1983b. :param T: [K] temperature :param y_C: Carbon mass fraction :param y_H: Hydrogen mass fraction :param y_O: Oxygen mass fraction ...
[ "Calculate", "the", "enthalpy", "at", "the", "specified", "temperature", "and", "composition", "using", "equation", "9", "in", "Merrick1983b", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/coals.py#L143-L170
[ "def", "calculate", "(", "self", ",", "*", "*", "state", ")", ":", "T", "=", "state", "[", "'T'", "]", "y_C", "=", "state", "[", "'y_C'", "]", "y_H", "=", "state", "[", "'y_H'", "]", "y_O", "=", "state", "[", "'y_O'", "]", "y_N", "=", "state", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
TimeBasedModel.create_entity
Create an entity and add it to the model. :param name: The entity name. :param gl_structure: The entity's general ledger structure. :param description: The entity description. :returns: The created entity.
auxi/modelling/business/models.py
def create_entity(self, name, gl_structure, description=None): """ Create an entity and add it to the model. :param name: The entity name. :param gl_structure: The entity's general ledger structure. :param description: The entity description. :returns: The created entit...
def create_entity(self, name, gl_structure, description=None): """ Create an entity and add it to the model. :param name: The entity name. :param gl_structure: The entity's general ledger structure. :param description: The entity description. :returns: The created entit...
[ "Create", "an", "entity", "and", "add", "it", "to", "the", "model", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/business/models.py#L65-L78
[ "def", "create_entity", "(", "self", ",", "name", ",", "gl_structure", ",", "description", "=", "None", ")", ":", "new_entity", "=", "Entity", "(", "name", ",", "gl_structure", ",", "description", "=", "description", ")", "self", ".", "entities", ".", "app...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
TimeBasedModel.remove_entity
Remove an entity from the model. :param name: The name of the entity to remove.
auxi/modelling/business/models.py
def remove_entity(self, name): """ Remove an entity from the model. :param name: The name of the entity to remove. """ entity_to_remove = None for e in self.entities: if e.name == name: entity_to_remove = e if entity_to_remove is not ...
def remove_entity(self, name): """ Remove an entity from the model. :param name: The name of the entity to remove. """ entity_to_remove = None for e in self.entities: if e.name == name: entity_to_remove = e if entity_to_remove is not ...
[ "Remove", "an", "entity", "from", "the", "model", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/business/models.py#L80-L92
[ "def", "remove_entity", "(", "self", ",", "name", ")", ":", "entity_to_remove", "=", "None", "for", "e", "in", "self", ".", "entities", ":", "if", "e", ".", "name", "==", "name", ":", "entity_to_remove", "=", "e", "if", "entity_to_remove", "is", "not", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
TimeBasedModel.prepare_to_run
Prepare the model for execution.
auxi/modelling/business/models.py
def prepare_to_run(self): """ Prepare the model for execution. """ self.clock.reset() for e in self.entities: e.prepare_to_run(self.clock, self.period_count)
def prepare_to_run(self): """ Prepare the model for execution. """ self.clock.reset() for e in self.entities: e.prepare_to_run(self.clock, self.period_count)
[ "Prepare", "the", "model", "for", "execution", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/business/models.py#L94-L101
[ "def", "prepare_to_run", "(", "self", ")", ":", "self", ".", "clock", ".", "reset", "(", ")", "for", "e", "in", "self", ".", "entities", ":", "e", ".", "prepare_to_run", "(", "self", ".", "clock", ",", "self", ".", "period_count", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
TimeBasedModel.run
Execute the model.
auxi/modelling/business/models.py
def run(self): """ Execute the model. """ self.prepare_to_run() for i in range(0, self.period_count): for e in self.entities: e.run(self.clock) self.clock.tick()
def run(self): """ Execute the model. """ self.prepare_to_run() for i in range(0, self.period_count): for e in self.entities: e.run(self.clock) self.clock.tick()
[ "Execute", "the", "model", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/business/models.py#L103-L112
[ "def", "run", "(", "self", ")", ":", "self", ".", "prepare_to_run", "(", ")", "for", "i", "in", "range", "(", "0", ",", "self", ".", "period_count", ")", ":", "for", "e", "in", "self", ".", "entities", ":", "e", ".", "run", "(", "self", ".", "c...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material._create_element_list
Extract an alphabetically sorted list of elements from the material's compounds. :returns: Alphabetically sorted list of elements.
auxi/modelling/process/materials/thermo.py
def _create_element_list(self): """ Extract an alphabetically sorted list of elements from the material's compounds. :returns: Alphabetically sorted list of elements. """ element_set = stoich.elements(self.compounds) return sorted(list(element_set))
def _create_element_list(self): """ Extract an alphabetically sorted list of elements from the material's compounds. :returns: Alphabetically sorted list of elements. """ element_set = stoich.elements(self.compounds) return sorted(list(element_set))
[ "Extract", "an", "alphabetically", "sorted", "list", "of", "elements", "from", "the", "material", "s", "compounds", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L246-L255
[ "def", "_create_element_list", "(", "self", ")", ":", "element_set", "=", "stoich", ".", "elements", "(", "self", ".", "compounds", ")", "return", "sorted", "(", "list", "(", "element_set", ")", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.add_assay
Add an assay to the material. :param name: Assay name. :param assay: Numpy array containing the compound mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material's compounds.
auxi/modelling/process/materials/thermo.py
def add_assay(self, name, assay): """ Add an assay to the material. :param name: Assay name. :param assay: Numpy array containing the compound mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material's compou...
def add_assay(self, name, assay): """ Add an assay to the material. :param name: Assay name. :param assay: Numpy array containing the compound mass fractions for the assay. The sequence of the assay's elements must correspond to the sequence of the material's compou...
[ "Add", "an", "assay", "to", "the", "material", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L289-L308
[ "def", "add_assay", "(", "self", ",", "name", ",", "assay", ")", ":", "if", "not", "type", "(", "assay", ")", "is", "numpy", ".", "ndarray", ":", "raise", "Exception", "(", "\"Invalid assay. It must be a numpy array.\"", ")", "elif", "not", "assay", ".", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.create_package
Create a MaterialPackage based on the specified parameters. :param assay: Name of the assay to be used to create the package. :param mass: Package mass. [kg] :param P: Package pressure. [atm] :param T: Package temperature. [°C] :param normalise: Indicate...
auxi/modelling/process/materials/thermo.py
def create_package(self, assay=None, mass=0.0, P=1.0, T=25.0, normalise=True): """ Create a MaterialPackage based on the specified parameters. :param assay: Name of the assay to be used to create the package. :param mass: Package mass. [kg] :param...
def create_package(self, assay=None, mass=0.0, P=1.0, T=25.0, normalise=True): """ Create a MaterialPackage based on the specified parameters. :param assay: Name of the assay to be used to create the package. :param mass: Package mass. [kg] :param...
[ "Create", "a", "MaterialPackage", "based", "on", "the", "specified", "parameters", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L321-L346
[ "def", "create_package", "(", "self", ",", "assay", "=", "None", ",", "mass", "=", "0.0", ",", "P", "=", "1.0", ",", "T", "=", "25.0", ",", "normalise", "=", "True", ")", ":", "if", "assay", "is", "None", ":", "return", "MaterialPackage", "(", "sel...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Material.create_stream
Create a MaterialStream based on the specified parameters. :param assay: Name of the assay to be used to create the stream. :param mfr: Stream mass flow rate. [kg/h] :param P: Stream pressure. [atm] :param T: Stream temperature. [°C] :param normalise: Indicates whether the assay...
auxi/modelling/process/materials/thermo.py
def create_stream(self, assay=None, mfr=0.0, P=1.0, T=25.0, normalise=True): """ Create a MaterialStream based on the specified parameters. :param assay: Name of the assay to be used to create the stream. :param mfr: Stream mass flow rate. [kg/h] :param P: ...
def create_stream(self, assay=None, mfr=0.0, P=1.0, T=25.0, normalise=True): """ Create a MaterialStream based on the specified parameters. :param assay: Name of the assay to be used to create the stream. :param mfr: Stream mass flow rate. [kg/h] :param P: ...
[ "Create", "a", "MaterialStream", "based", "on", "the", "specified", "parameters", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L348-L373
[ "def", "create_stream", "(", "self", ",", "assay", "=", "None", ",", "mfr", "=", "0.0", ",", "P", "=", "1.0", ",", "T", "=", "25.0", ",", "normalise", "=", "True", ")", ":", "if", "assay", "is", "None", ":", "return", "MaterialStream", "(", "self",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage._calculate_H
Calculate the enthalpy of the package at the specified temperature. :param T: Temperature. [°C] :returns: Enthalpy. [kWh]
auxi/modelling/process/materials/thermo.py
def _calculate_H(self, T): """ Calculate the enthalpy of the package at the specified temperature. :param T: Temperature. [°C] :returns: Enthalpy. [kWh] """ if self.isCoal: return self._calculate_Hfr_coal(T) H = 0.0 for compound in self.mat...
def _calculate_H(self, T): """ Calculate the enthalpy of the package at the specified temperature. :param T: Temperature. [°C] :returns: Enthalpy. [kWh] """ if self.isCoal: return self._calculate_Hfr_coal(T) H = 0.0 for compound in self.mat...
[ "Calculate", "the", "enthalpy", "of", "the", "package", "at", "the", "specified", "temperature", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L582-L599
[ "def", "_calculate_H", "(", "self", ",", "T", ")", ":", "if", "self", ".", "isCoal", ":", "return", "self", ".", "_calculate_Hfr_coal", "(", "T", ")", "H", "=", "0.0", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "index", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage._calculate_H_coal
Calculate the enthalpy of the package at the specified temperature, in case the material is coal. :param T: [°C] temperature :returns: [kWh] enthalpy
auxi/modelling/process/materials/thermo.py
def _calculate_H_coal(self, T): """ Calculate the enthalpy of the package at the specified temperature, in case the material is coal. :param T: [°C] temperature :returns: [kWh] enthalpy """ m_C = 0 # kg m_H = 0 # kg m_O = 0 # kg m_N =...
def _calculate_H_coal(self, T): """ Calculate the enthalpy of the package at the specified temperature, in case the material is coal. :param T: [°C] temperature :returns: [kWh] enthalpy """ m_C = 0 # kg m_H = 0 # kg m_O = 0 # kg m_N =...
[ "Calculate", "the", "enthalpy", "of", "the", "package", "at", "the", "specified", "temperature", "in", "case", "the", "material", "is", "coal", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L654-L704
[ "def", "_calculate_H_coal", "(", "self", ",", "T", ")", ":", "m_C", "=", "0", "# kg", "m_H", "=", "0", "# kg", "m_O", "=", "0", "# kg", "m_N", "=", "0", "# kg", "m_S", "=", "0", "# kg", "H", "=", "0.0", "# kWh/h", "for", "compound", "in", "self",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage._calculate_T
Calculate the temperature of the package given the specified enthalpy using a secant algorithm. :param H: Enthalpy. [kWh] :returns: Temperature. [°C]
auxi/modelling/process/materials/thermo.py
def _calculate_T(self, H): """ Calculate the temperature of the package given the specified enthalpy using a secant algorithm. :param H: Enthalpy. [kWh] :returns: Temperature. [°C] """ # Create the initial guesses for temperature. x = list() x.a...
def _calculate_T(self, H): """ Calculate the temperature of the package given the specified enthalpy using a secant algorithm. :param H: Enthalpy. [kWh] :returns: Temperature. [°C] """ # Create the initial guesses for temperature. x = list() x.a...
[ "Calculate", "the", "temperature", "of", "the", "package", "given", "the", "specified", "enthalpy", "using", "a", "secant", "algorithm", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L706-L733
[ "def", "_calculate_T", "(", "self", ",", "H", ")", ":", "# Create the initial guesses for temperature.", "x", "=", "list", "(", ")", "x", ".", "append", "(", "self", ".", "_T", ")", "x", ".", "append", "(", "self", ".", "_T", "+", "10.0", ")", "# Evalu...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage._is_compound_mass_tuple
Determines whether value is a tuple of the format (compound(str), mass(float)). :param value: The value to be tested. :returns: True or False
auxi/modelling/process/materials/thermo.py
def _is_compound_mass_tuple(self, value): """ Determines whether value is a tuple of the format (compound(str), mass(float)). :param value: The value to be tested. :returns: True or False """ if not type(value) is tuple: return False elif no...
def _is_compound_mass_tuple(self, value): """ Determines whether value is a tuple of the format (compound(str), mass(float)). :param value: The value to be tested. :returns: True or False """ if not type(value) is tuple: return False elif no...
[ "Determines", "whether", "value", "is", "a", "tuple", "of", "the", "format", "(", "compound", "(", "str", ")", "mass", "(", "float", "))", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L735-L756
[ "def", "_is_compound_mass_tuple", "(", "self", ",", "value", ")", ":", "if", "not", "type", "(", "value", ")", "is", "tuple", ":", "return", "False", "elif", "not", "len", "(", "value", ")", "==", "2", ":", "return", "False", "elif", "not", "type", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.H
Set the enthalpy of the package to the specified value, and recalculate it's temperature. :param H: The new enthalpy value. [kWh]
auxi/modelling/process/materials/thermo.py
def H(self, H): """ Set the enthalpy of the package to the specified value, and recalculate it's temperature. :param H: The new enthalpy value. [kWh] """ self._H = H self._T = self._calculate_T(H)
def H(self, H): """ Set the enthalpy of the package to the specified value, and recalculate it's temperature. :param H: The new enthalpy value. [kWh] """ self._H = H self._T = self._calculate_T(H)
[ "Set", "the", "enthalpy", "of", "the", "package", "to", "the", "specified", "value", "and", "recalculate", "it", "s", "temperature", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L794-L803
[ "def", "H", "(", "self", ",", "H", ")", ":", "self", ".", "_H", "=", "H", "self", ".", "_T", "=", "self", ".", "_calculate_T", "(", "H", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.T
Set the temperature of the package to the specified value, and recalculate it's enthalpy. :param T: Temperature. [°C]
auxi/modelling/process/materials/thermo.py
def T(self, T): """ Set the temperature of the package to the specified value, and recalculate it's enthalpy. :param T: Temperature. [°C] """ self._T = T self._H = self._calculate_H(T)
def T(self, T): """ Set the temperature of the package to the specified value, and recalculate it's enthalpy. :param T: Temperature. [°C] """ self._T = T self._H = self._calculate_H(T)
[ "Set", "the", "temperature", "of", "the", "package", "to", "the", "specified", "value", "and", "recalculate", "it", "s", "enthalpy", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L816-L825
[ "def", "T", "(", "self", ",", "T", ")", ":", "self", ".", "_T", "=", "T", "self", ".", "_H", "=", "self", ".", "_calculate_H", "(", "T", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.clone
Create a complete copy of the package. :returns: A new MaterialPackage object.
auxi/modelling/process/materials/thermo.py
def clone(self): """Create a complete copy of the package. :returns: A new MaterialPackage object.""" result = copy.copy(self) result._compound_masses = copy.deepcopy(self._compound_masses) return result
def clone(self): """Create a complete copy of the package. :returns: A new MaterialPackage object.""" result = copy.copy(self) result._compound_masses = copy.deepcopy(self._compound_masses) return result
[ "Create", "a", "complete", "copy", "of", "the", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L846-L853
[ "def", "clone", "(", "self", ")", ":", "result", "=", "copy", ".", "copy", "(", "self", ")", "result", ".", "_compound_masses", "=", "copy", ".", "deepcopy", "(", "self", ".", "_compound_masses", ")", "return", "result" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.clear
Set all the compound masses in the package to zero. Set the pressure to 1, the temperature to 25 and the enthalpy to zero.
auxi/modelling/process/materials/thermo.py
def clear(self): """ Set all the compound masses in the package to zero. Set the pressure to 1, the temperature to 25 and the enthalpy to zero. """ self._compound_masses = self._compound_masses * 0.0 self._P = 1.0 self._T = 25.0 self._H = 0.0
def clear(self): """ Set all the compound masses in the package to zero. Set the pressure to 1, the temperature to 25 and the enthalpy to zero. """ self._compound_masses = self._compound_masses * 0.0 self._P = 1.0 self._T = 25.0 self._H = 0.0
[ "Set", "all", "the", "compound", "masses", "in", "the", "package", "to", "zero", ".", "Set", "the", "pressure", "to", "1", "the", "temperature", "to", "25", "and", "the", "enthalpy", "to", "zero", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L855-L864
[ "def", "clear", "(", "self", ")", ":", "self", ".", "_compound_masses", "=", "self", ".", "_compound_masses", "*", "0.0", "self", ".", "_P", "=", "1.0", "self", ".", "_T", "=", "25.0", "self", ".", "_H", "=", "0.0" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_compound_mass
Determine the mass of the specified compound in the package. :param compound: Formula and phase of a compound, e.g. "Fe2O3[S1]". :returns: Mass. [kg]
auxi/modelling/process/materials/thermo.py
def get_compound_mass(self, compound): """ Determine the mass of the specified compound in the package. :param compound: Formula and phase of a compound, e.g. "Fe2O3[S1]". :returns: Mass. [kg] """ if compound in self.material.compounds: return self._compoun...
def get_compound_mass(self, compound): """ Determine the mass of the specified compound in the package. :param compound: Formula and phase of a compound, e.g. "Fe2O3[S1]". :returns: Mass. [kg] """ if compound in self.material.compounds: return self._compoun...
[ "Determine", "the", "mass", "of", "the", "specified", "compound", "in", "the", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L885-L898
[ "def", "get_compound_mass", "(", "self", ",", "compound", ")", ":", "if", "compound", "in", "self", ".", "material", ".", "compounds", ":", "return", "self", ".", "_compound_masses", "[", "self", ".", "material", ".", "get_compound_index", "(", "compound", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_compound_amounts
Determine the mole amounts of all the compounds. :returns: List of amounts. [kmol]
auxi/modelling/process/materials/thermo.py
def get_compound_amounts(self): """ Determine the mole amounts of all the compounds. :returns: List of amounts. [kmol] """ result = self._compound_masses * 1.0 for compound in self.material.compounds: index = self.material.get_compound_index(compound) ...
def get_compound_amounts(self): """ Determine the mole amounts of all the compounds. :returns: List of amounts. [kmol] """ result = self._compound_masses * 1.0 for compound in self.material.compounds: index = self.material.get_compound_index(compound) ...
[ "Determine", "the", "mole", "amounts", "of", "all", "the", "compounds", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L900-L911
[ "def", "get_compound_amounts", "(", "self", ")", ":", "result", "=", "self", ".", "_compound_masses", "*", "1.0", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "index", "=", "self", ".", "material", ".", "get_compound_index", "(", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_compound_amount
Determine the mole amount of the specified compound. :returns: Amount. [kmol]
auxi/modelling/process/materials/thermo.py
def get_compound_amount(self, compound): """ Determine the mole amount of the specified compound. :returns: Amount. [kmol] """ index = self.material.get_compound_index(compound) return stoich.amount(compound, self._compound_masses[index])
def get_compound_amount(self, compound): """ Determine the mole amount of the specified compound. :returns: Amount. [kmol] """ index = self.material.get_compound_index(compound) return stoich.amount(compound, self._compound_masses[index])
[ "Determine", "the", "mole", "amount", "of", "the", "specified", "compound", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L913-L921
[ "def", "get_compound_amount", "(", "self", ",", "compound", ")", ":", "index", "=", "self", ".", "material", ".", "get_compound_index", "(", "compound", ")", "return", "stoich", ".", "amount", "(", "compound", ",", "self", ".", "_compound_masses", "[", "inde...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.amount
Determine the sum of mole amounts of all the compounds. :returns: Amount. [kmol]
auxi/modelling/process/materials/thermo.py
def amount(self): """ Determine the sum of mole amounts of all the compounds. :returns: Amount. [kmol] """ return sum(self.get_compound_amount(c) for c in self.material.compounds)
def amount(self): """ Determine the sum of mole amounts of all the compounds. :returns: Amount. [kmol] """ return sum(self.get_compound_amount(c) for c in self.material.compounds)
[ "Determine", "the", "sum", "of", "mole", "amounts", "of", "all", "the", "compounds", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L924-L931
[ "def", "amount", "(", "self", ")", ":", "return", "sum", "(", "self", ".", "get_compound_amount", "(", "c", ")", "for", "c", "in", "self", ".", "material", ".", "compounds", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_element_masses
Determine the masses of elements in the package. :returns: Array of element masses. [kg]
auxi/modelling/process/materials/thermo.py
def get_element_masses(self, elements=None): """ Determine the masses of elements in the package. :returns: Array of element masses. [kg] """ if elements is None: elements = self.material.elements result = numpy.zeros(len(elements)) for compound in ...
def get_element_masses(self, elements=None): """ Determine the masses of elements in the package. :returns: Array of element masses. [kg] """ if elements is None: elements = self.material.elements result = numpy.zeros(len(elements)) for compound in ...
[ "Determine", "the", "masses", "of", "elements", "in", "the", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L933-L947
[ "def", "get_element_masses", "(", "self", ",", "elements", "=", "None", ")", ":", "if", "elements", "is", "None", ":", "elements", "=", "self", ".", "material", ".", "elements", "result", "=", "numpy", ".", "zeros", "(", "len", "(", "elements", ")", ")...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_element_mass_dictionary
Determine the masses of elements in the package and return as a dictionary. :returns: Dictionary of element symbols and masses. [kg]
auxi/modelling/process/materials/thermo.py
def get_element_mass_dictionary(self): """ Determine the masses of elements in the package and return as a dictionary. :returns: Dictionary of element symbols and masses. [kg] """ element_symbols = self.material.elements element_masses = self.get_element_masses(...
def get_element_mass_dictionary(self): """ Determine the masses of elements in the package and return as a dictionary. :returns: Dictionary of element symbols and masses. [kg] """ element_symbols = self.material.elements element_masses = self.get_element_masses(...
[ "Determine", "the", "masses", "of", "elements", "in", "the", "package", "and", "return", "as", "a", "dictionary", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L949-L960
[ "def", "get_element_mass_dictionary", "(", "self", ")", ":", "element_symbols", "=", "self", ".", "material", ".", "elements", "element_masses", "=", "self", ".", "get_element_masses", "(", ")", "return", "{", "s", ":", "m", "for", "s", ",", "m", "in", "zi...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.get_element_mass
Determine the mass of the specified elements in the package. :returns: Masses. [kg]
auxi/modelling/process/materials/thermo.py
def get_element_mass(self, element): """ Determine the mass of the specified elements in the package. :returns: Masses. [kg] """ result = numpy.zeros(1) for compound in self.material.compounds: result += self.get_compound_mass(compound) *\ nu...
def get_element_mass(self, element): """ Determine the mass of the specified elements in the package. :returns: Masses. [kg] """ result = numpy.zeros(1) for compound in self.material.compounds: result += self.get_compound_mass(compound) *\ nu...
[ "Determine", "the", "mass", "of", "the", "specified", "elements", "in", "the", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L962-L973
[ "def", "get_element_mass", "(", "self", ",", "element", ")", ":", "result", "=", "numpy", ".", "zeros", "(", "1", ")", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "result", "+=", "self", ".", "get_compound_mass", "(", "compou...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialPackage.extract
Extract 'other' from this package, modifying this package and returning the extracted material as a new package. :param other: Can be one of the following: * float: A mass equal to other is extracted from self. Self is reduced by other and the extracted package is returned as ...
auxi/modelling/process/materials/thermo.py
def extract(self, other): """ Extract 'other' from this package, modifying this package and returning the extracted material as a new package. :param other: Can be one of the following: * float: A mass equal to other is extracted from self. Self is reduced by othe...
def extract(self, other): """ Extract 'other' from this package, modifying this package and returning the extracted material as a new package. :param other: Can be one of the following: * float: A mass equal to other is extracted from self. Self is reduced by othe...
[ "Extract", "other", "from", "this", "package", "modifying", "this", "package", "and", "returning", "the", "extracted", "material", "as", "a", "new", "package", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L975-L1019
[ "def", "extract", "(", "self", ",", "other", ")", ":", "# Extract the specified mass.", "if", "type", "(", "other", ")", "is", "float", "or", "type", "(", "other", ")", "is", "numpy", ".", "float64", "or", "type", "(", "other", ")", "is", "numpy", ".",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream._calculate_Hfr
Calculate the enthalpy flow rate of the stream at the specified temperature. :param T: Temperature. [°C] :returns: Enthalpy flow rate. [kWh/h]
auxi/modelling/process/materials/thermo.py
def _calculate_Hfr(self, T): """ Calculate the enthalpy flow rate of the stream at the specified temperature. :param T: Temperature. [°C] :returns: Enthalpy flow rate. [kWh/h] """ if self.isCoal: return self._calculate_Hfr_coal(T) Hfr = 0.0...
def _calculate_Hfr(self, T): """ Calculate the enthalpy flow rate of the stream at the specified temperature. :param T: Temperature. [°C] :returns: Enthalpy flow rate. [kWh/h] """ if self.isCoal: return self._calculate_Hfr_coal(T) Hfr = 0.0...
[ "Calculate", "the", "enthalpy", "flow", "rate", "of", "the", "stream", "at", "the", "specified", "temperature", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1297-L1315
[ "def", "_calculate_Hfr", "(", "self", ",", "T", ")", ":", "if", "self", ".", "isCoal", ":", "return", "self", ".", "_calculate_Hfr_coal", "(", "T", ")", "Hfr", "=", "0.0", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "index"...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream._calculate_DH298_coal
Calculate the enthalpy of formation of the dry-ash-free (daf) component of the coal. :returns: [kWh/kg daf] enthalpy of formation of daf coal
auxi/modelling/process/materials/thermo.py
def _calculate_DH298_coal(self): """ Calculate the enthalpy of formation of the dry-ash-free (daf) component of the coal. :returns: [kWh/kg daf] enthalpy of formation of daf coal """ m_C = 0 # kg m_H = 0 # kg m_O = 0 # kg m_N = 0 # kg m_S = 0...
def _calculate_DH298_coal(self): """ Calculate the enthalpy of formation of the dry-ash-free (daf) component of the coal. :returns: [kWh/kg daf] enthalpy of formation of daf coal """ m_C = 0 # kg m_H = 0 # kg m_O = 0 # kg m_N = 0 # kg m_S = 0...
[ "Calculate", "the", "enthalpy", "of", "formation", "of", "the", "dry", "-", "ash", "-", "free", "(", "daf", ")", "component", "of", "the", "coal", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1317-L1370
[ "def", "_calculate_DH298_coal", "(", "self", ")", ":", "m_C", "=", "0", "# kg", "m_H", "=", "0", "# kg", "m_O", "=", "0", "# kg", "m_N", "=", "0", "# kg", "m_S", "=", "0", "# kg", "T", "=", "25", "# °C", "Hin", "=", "0.0", "# kWh", "for", "compou...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream._calculate_Hfr_coal
Calculate the enthalpy flow rate of the stream at the specified temperature, in the case of it being coal. :param T: Temperature. [°C] :returns: Enthalpy flow rate. [kWh/h]
auxi/modelling/process/materials/thermo.py
def _calculate_Hfr_coal(self, T): """ Calculate the enthalpy flow rate of the stream at the specified temperature, in the case of it being coal. :param T: Temperature. [°C] :returns: Enthalpy flow rate. [kWh/h] """ m_C = 0 # kg/h m_H = 0 # kg/h ...
def _calculate_Hfr_coal(self, T): """ Calculate the enthalpy flow rate of the stream at the specified temperature, in the case of it being coal. :param T: Temperature. [°C] :returns: Enthalpy flow rate. [kWh/h] """ m_C = 0 # kg/h m_H = 0 # kg/h ...
[ "Calculate", "the", "enthalpy", "flow", "rate", "of", "the", "stream", "at", "the", "specified", "temperature", "in", "the", "case", "of", "it", "being", "coal", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1372-L1423
[ "def", "_calculate_Hfr_coal", "(", "self", ",", "T", ")", ":", "m_C", "=", "0", "# kg/h", "m_H", "=", "0", "# kg/h", "m_O", "=", "0", "# kg/h", "m_N", "=", "0", "# kg/h", "m_S", "=", "0", "# kg/h", "Hfr", "=", "0.0", "# kWh/h", "for", "compound", "...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream._calculate_T
Calculate the temperature of the stream given the specified enthalpy flow rate using a secant algorithm. :param H: Enthalpy flow rate. [kWh/h] :returns: Temperature. [°C]
auxi/modelling/process/materials/thermo.py
def _calculate_T(self, Hfr): """ Calculate the temperature of the stream given the specified enthalpy flow rate using a secant algorithm. :param H: Enthalpy flow rate. [kWh/h] :returns: Temperature. [°C] """ # Create the initial guesses for temperature. ...
def _calculate_T(self, Hfr): """ Calculate the temperature of the stream given the specified enthalpy flow rate using a secant algorithm. :param H: Enthalpy flow rate. [kWh/h] :returns: Temperature. [°C] """ # Create the initial guesses for temperature. ...
[ "Calculate", "the", "temperature", "of", "the", "stream", "given", "the", "specified", "enthalpy", "flow", "rate", "using", "a", "secant", "algorithm", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1425-L1452
[ "def", "_calculate_T", "(", "self", ",", "Hfr", ")", ":", "# Create the initial guesses for temperature.", "x", "=", "list", "(", ")", "x", ".", "append", "(", "self", ".", "_T", ")", "x", ".", "append", "(", "self", ".", "_T", "+", "10.0", ")", "# Eva...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream._is_compound_mfr_temperature_tuple
Determines whether value is a tuple of the format (compound(str), mfr(float), temperature(float)). :param value: The value to be tested. :returns: True or False
auxi/modelling/process/materials/thermo.py
def _is_compound_mfr_temperature_tuple(self, value): """Determines whether value is a tuple of the format (compound(str), mfr(float), temperature(float)). :param value: The value to be tested. :returns: True or False""" if not type(value) is tuple: return False ...
def _is_compound_mfr_temperature_tuple(self, value): """Determines whether value is a tuple of the format (compound(str), mfr(float), temperature(float)). :param value: The value to be tested. :returns: True or False""" if not type(value) is tuple: return False ...
[ "Determines", "whether", "value", "is", "a", "tuple", "of", "the", "format", "(", "compound", "(", "str", ")", "mfr", "(", "float", ")", "temperature", "(", "float", "))", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1477-L1500
[ "def", "_is_compound_mfr_temperature_tuple", "(", "self", ",", "value", ")", ":", "if", "not", "type", "(", "value", ")", "is", "tuple", ":", "return", "False", "elif", "not", "len", "(", "value", ")", "==", "3", ":", "return", "False", "elif", "not", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.Hfr
Set the enthalpy flow rate of the stream to the specified value, and recalculate it's temperature. :param H: The new enthalpy flow rate value. [kWh/h]
auxi/modelling/process/materials/thermo.py
def Hfr(self, Hfr): """ Set the enthalpy flow rate of the stream to the specified value, and recalculate it's temperature. :param H: The new enthalpy flow rate value. [kWh/h] """ self._Hfr = Hfr self._T = self._calculate_T(Hfr)
def Hfr(self, Hfr): """ Set the enthalpy flow rate of the stream to the specified value, and recalculate it's temperature. :param H: The new enthalpy flow rate value. [kWh/h] """ self._Hfr = Hfr self._T = self._calculate_T(Hfr)
[ "Set", "the", "enthalpy", "flow", "rate", "of", "the", "stream", "to", "the", "specified", "value", "and", "recalculate", "it", "s", "temperature", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1513-L1522
[ "def", "Hfr", "(", "self", ",", "Hfr", ")", ":", "self", ".", "_Hfr", "=", "Hfr", "self", ".", "_T", "=", "self", ".", "_calculate_T", "(", "Hfr", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.T
Set the temperature of the stream to the specified value, and recalculate it's enthalpy. :param T: Temperature. [°C]
auxi/modelling/process/materials/thermo.py
def T(self, T): """ Set the temperature of the stream to the specified value, and recalculate it's enthalpy. :param T: Temperature. [°C] """ self._T = T self._Hfr = self._calculate_Hfr(T)
def T(self, T): """ Set the temperature of the stream to the specified value, and recalculate it's enthalpy. :param T: Temperature. [°C] """ self._T = T self._Hfr = self._calculate_Hfr(T)
[ "Set", "the", "temperature", "of", "the", "stream", "to", "the", "specified", "value", "and", "recalculate", "it", "s", "enthalpy", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1535-L1544
[ "def", "T", "(", "self", ",", "T", ")", ":", "self", ".", "_T", "=", "T", "self", ".", "_Hfr", "=", "self", ".", "_calculate_Hfr", "(", "T", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.HHV
Set the higher heating value of the stream to the specified value, and recalculate the formation enthalpy of the daf coal. :param HHV: MJ/kg coal, higher heating value
auxi/modelling/process/materials/thermo.py
def HHV(self, HHV): """ Set the higher heating value of the stream to the specified value, and recalculate the formation enthalpy of the daf coal. :param HHV: MJ/kg coal, higher heating value """ self._HHV = HHV # MJ/kg coal if self.isCoal: self._DH...
def HHV(self, HHV): """ Set the higher heating value of the stream to the specified value, and recalculate the formation enthalpy of the daf coal. :param HHV: MJ/kg coal, higher heating value """ self._HHV = HHV # MJ/kg coal if self.isCoal: self._DH...
[ "Set", "the", "higher", "heating", "value", "of", "the", "stream", "to", "the", "specified", "value", "and", "recalculate", "the", "formation", "enthalpy", "of", "the", "daf", "coal", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1557-L1567
[ "def", "HHV", "(", "self", ",", "HHV", ")", ":", "self", ".", "_HHV", "=", "HHV", "# MJ/kg coal", "if", "self", ".", "isCoal", ":", "self", ".", "_DH298", "=", "self", ".", "_calculate_DH298_coal", "(", ")" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.clone
Create a complete copy of the stream. :returns: A new MaterialStream object.
auxi/modelling/process/materials/thermo.py
def clone(self): """Create a complete copy of the stream. :returns: A new MaterialStream object.""" result = copy.copy(self) result._compound_mfrs = copy.deepcopy(self._compound_mfrs) return result
def clone(self): """Create a complete copy of the stream. :returns: A new MaterialStream object.""" result = copy.copy(self) result._compound_mfrs = copy.deepcopy(self._compound_mfrs) return result
[ "Create", "a", "complete", "copy", "of", "the", "stream", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1588-L1595
[ "def", "clone", "(", "self", ")", ":", "result", "=", "copy", ".", "copy", "(", "self", ")", "result", ".", "_compound_mfrs", "=", "copy", ".", "deepcopy", "(", "self", ".", "_compound_mfrs", ")", "return", "result" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.clear
Set all the compound mass flow rates in the stream to zero. Set the pressure to 1, the temperature to 25 and the enthalpy to zero.
auxi/modelling/process/materials/thermo.py
def clear(self): """ Set all the compound mass flow rates in the stream to zero. Set the pressure to 1, the temperature to 25 and the enthalpy to zero. """ self._compound_mfrs = self._compound_mfrs * 0.0 self._P = 1.0 self._T = 25.0 self._H = 0.0
def clear(self): """ Set all the compound mass flow rates in the stream to zero. Set the pressure to 1, the temperature to 25 and the enthalpy to zero. """ self._compound_mfrs = self._compound_mfrs * 0.0 self._P = 1.0 self._T = 25.0 self._H = 0.0
[ "Set", "all", "the", "compound", "mass", "flow", "rates", "in", "the", "stream", "to", "zero", ".", "Set", "the", "pressure", "to", "1", "the", "temperature", "to", "25", "and", "the", "enthalpy", "to", "zero", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1597-L1606
[ "def", "clear", "(", "self", ")", ":", "self", ".", "_compound_mfrs", "=", "self", ".", "_compound_mfrs", "*", "0.0", "self", ".", "_P", "=", "1.0", "self", ".", "_T", "=", "25.0", "self", ".", "_H", "=", "0.0" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.get_compound_mfr
Determine the mass flow rate of the specified compound in the stream. :param compound: Formula and phase of a compound, e.g. "Fe2O3[S1]". :returns: Mass flow rate. [kg/h]
auxi/modelling/process/materials/thermo.py
def get_compound_mfr(self, compound): """ Determine the mass flow rate of the specified compound in the stream. :param compound: Formula and phase of a compound, e.g. "Fe2O3[S1]". :returns: Mass flow rate. [kg/h] """ if compound in self.material.compounds: ...
def get_compound_mfr(self, compound): """ Determine the mass flow rate of the specified compound in the stream. :param compound: Formula and phase of a compound, e.g. "Fe2O3[S1]". :returns: Mass flow rate. [kg/h] """ if compound in self.material.compounds: ...
[ "Determine", "the", "mass", "flow", "rate", "of", "the", "specified", "compound", "in", "the", "stream", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1627-L1640
[ "def", "get_compound_mfr", "(", "self", ",", "compound", ")", ":", "if", "compound", "in", "self", ".", "material", ".", "compounds", ":", "return", "self", ".", "_compound_mfrs", "[", "self", ".", "material", ".", "get_compound_index", "(", "compound", ")",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.get_compound_afrs
Determine the amount flow rates of all the compounds. :returns: List of amount flow rates. [kmol/h]
auxi/modelling/process/materials/thermo.py
def get_compound_afrs(self): """ Determine the amount flow rates of all the compounds. :returns: List of amount flow rates. [kmol/h] """ result = self._compound_mfrs * 1.0 for compound in self.material.compounds: index = self.material.get_compound_index(comp...
def get_compound_afrs(self): """ Determine the amount flow rates of all the compounds. :returns: List of amount flow rates. [kmol/h] """ result = self._compound_mfrs * 1.0 for compound in self.material.compounds: index = self.material.get_compound_index(comp...
[ "Determine", "the", "amount", "flow", "rates", "of", "all", "the", "compounds", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1642-L1653
[ "def", "get_compound_afrs", "(", "self", ")", ":", "result", "=", "self", ".", "_compound_mfrs", "*", "1.0", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "index", "=", "self", ".", "material", ".", "get_compound_index", "(", "co...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.get_compound_afr
Determine the amount flow rate of the specified compound. :returns: Amount flow rate. [kmol/h]
auxi/modelling/process/materials/thermo.py
def get_compound_afr(self, compound): """ Determine the amount flow rate of the specified compound. :returns: Amount flow rate. [kmol/h] """ index = self.material.get_compound_index(compound) return stoich.amount(compound, self._compound_mfrs[index])
def get_compound_afr(self, compound): """ Determine the amount flow rate of the specified compound. :returns: Amount flow rate. [kmol/h] """ index = self.material.get_compound_index(compound) return stoich.amount(compound, self._compound_mfrs[index])
[ "Determine", "the", "amount", "flow", "rate", "of", "the", "specified", "compound", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1655-L1663
[ "def", "get_compound_afr", "(", "self", ",", "compound", ")", ":", "index", "=", "self", ".", "material", ".", "get_compound_index", "(", "compound", ")", "return", "stoich", ".", "amount", "(", "compound", ",", "self", ".", "_compound_mfrs", "[", "index", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.afr
Determine the sum of amount flow rates of all the compounds. :returns: Amount flow rate. [kmol/h]
auxi/modelling/process/materials/thermo.py
def afr(self): """ Determine the sum of amount flow rates of all the compounds. :returns: Amount flow rate. [kmol/h] """ result = 0.0 for compound in self.material.compounds: result += self.get_compound_afr(compound) return result
def afr(self): """ Determine the sum of amount flow rates of all the compounds. :returns: Amount flow rate. [kmol/h] """ result = 0.0 for compound in self.material.compounds: result += self.get_compound_afr(compound) return result
[ "Determine", "the", "sum", "of", "amount", "flow", "rates", "of", "all", "the", "compounds", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1666-L1676
[ "def", "afr", "(", "self", ")", ":", "result", "=", "0.0", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "result", "+=", "self", ".", "get_compound_afr", "(", "compound", ")", "return", "result" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.get_element_mfrs
Determine the mass flow rates of elements in the stream. :returns: Array of element mass flow rates. [kg/h]
auxi/modelling/process/materials/thermo.py
def get_element_mfrs(self, elements=None): """ Determine the mass flow rates of elements in the stream. :returns: Array of element mass flow rates. [kg/h] """ if elements is None: elements = self.material.elements result = numpy.zeros(len(elements)) ...
def get_element_mfrs(self, elements=None): """ Determine the mass flow rates of elements in the stream. :returns: Array of element mass flow rates. [kg/h] """ if elements is None: elements = self.material.elements result = numpy.zeros(len(elements)) ...
[ "Determine", "the", "mass", "flow", "rates", "of", "elements", "in", "the", "stream", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1678-L1691
[ "def", "get_element_mfrs", "(", "self", ",", "elements", "=", "None", ")", ":", "if", "elements", "is", "None", ":", "elements", "=", "self", ".", "material", ".", "elements", "result", "=", "numpy", ".", "zeros", "(", "len", "(", "elements", ")", ")",...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.get_element_mfr_dictionary
Determine the mass flow rates of elements in the stream and return as a dictionary. :returns: Dictionary of element symbols and mass flow rates. [kg/h]
auxi/modelling/process/materials/thermo.py
def get_element_mfr_dictionary(self): """ Determine the mass flow rates of elements in the stream and return as a dictionary. :returns: Dictionary of element symbols and mass flow rates. [kg/h] """ element_symbols = self.material.elements element_mfrs = self.get...
def get_element_mfr_dictionary(self): """ Determine the mass flow rates of elements in the stream and return as a dictionary. :returns: Dictionary of element symbols and mass flow rates. [kg/h] """ element_symbols = self.material.elements element_mfrs = self.get...
[ "Determine", "the", "mass", "flow", "rates", "of", "elements", "in", "the", "stream", "and", "return", "as", "a", "dictionary", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1693-L1706
[ "def", "get_element_mfr_dictionary", "(", "self", ")", ":", "element_symbols", "=", "self", ".", "material", ".", "elements", "element_mfrs", "=", "self", ".", "get_element_mfrs", "(", ")", "result", "=", "dict", "(", ")", "for", "s", ",", "mfr", "in", "zi...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.get_element_mfr
Determine the mass flow rate of the specified elements in the stream. :returns: Mass flow rates. [kg/h]
auxi/modelling/process/materials/thermo.py
def get_element_mfr(self, element): """ Determine the mass flow rate of the specified elements in the stream. :returns: Mass flow rates. [kg/h] """ result = 0.0 for compound in self.material.compounds: formula = compound.split('[')[0] result += s...
def get_element_mfr(self, element): """ Determine the mass flow rate of the specified elements in the stream. :returns: Mass flow rates. [kg/h] """ result = 0.0 for compound in self.material.compounds: formula = compound.split('[')[0] result += s...
[ "Determine", "the", "mass", "flow", "rate", "of", "the", "specified", "elements", "in", "the", "stream", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1708-L1720
[ "def", "get_element_mfr", "(", "self", ",", "element", ")", ":", "result", "=", "0.0", "for", "compound", "in", "self", ".", "material", ".", "compounds", ":", "formula", "=", "compound", ".", "split", "(", "'['", ")", "[", "0", "]", "result", "+=", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
MaterialStream.extract
Extract 'other' from this stream, modifying this stream and returning the extracted material as a new stream. :param other: Can be one of the following: * float: A mass flow rate equal to other is extracted from self. Self is reduced by other and the extracted stream is returned ...
auxi/modelling/process/materials/thermo.py
def extract(self, other): """ Extract 'other' from this stream, modifying this stream and returning the extracted material as a new stream. :param other: Can be one of the following: * float: A mass flow rate equal to other is extracted from self. Self is reduced ...
def extract(self, other): """ Extract 'other' from this stream, modifying this stream and returning the extracted material as a new stream. :param other: Can be one of the following: * float: A mass flow rate equal to other is extracted from self. Self is reduced ...
[ "Extract", "other", "from", "this", "stream", "modifying", "this", "stream", "and", "returning", "the", "extracted", "material", "as", "a", "new", "stream", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/modelling/process/materials/thermo.py#L1722-L1766
[ "def", "extract", "(", "self", ",", "other", ")", ":", "# Extract the specified mass flow rate.", "if", "type", "(", "other", ")", "is", "float", "or", "type", "(", "other", ")", "is", "numpy", ".", "float64", "or", "type", "(", "other", ")", "is", "nump...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Gr
Calculate the Grashof number. :param L: [m] heat transfer surface characteristic length. :param Ts: [K] heat transfer surface temperature. :param Tf: [K] bulk fluid temperature. :param beta: [1/K] fluid coefficient of thermal expansion. :param nu: [m2/s] fluid kinematic viscosity. :returns: fl...
auxi/tools/transportphenomena/dimensionlessquantities.py
def Gr(L: float, Ts: float, Tf: float, beta: float, nu: float, g: float): """ Calculate the Grashof number. :param L: [m] heat transfer surface characteristic length. :param Ts: [K] heat transfer surface temperature. :param Tf: [K] bulk fluid temperature. :param beta: [1/K] fluid coefficient of...
def Gr(L: float, Ts: float, Tf: float, beta: float, nu: float, g: float): """ Calculate the Grashof number. :param L: [m] heat transfer surface characteristic length. :param Ts: [K] heat transfer surface temperature. :param Tf: [K] bulk fluid temperature. :param beta: [1/K] fluid coefficient of...
[ "Calculate", "the", "Grashof", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/dimensionlessquantities.py#L29-L50
[ "def", "Gr", "(", "L", ":", "float", ",", "Ts", ":", "float", ",", "Tf", ":", "float", ",", "beta", ":", "float", ",", "nu", ":", "float", ",", "g", ":", "float", ")", ":", "return", "g", "*", "beta", "*", "(", "Ts", "-", "Tf", ")", "*", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Re
Calculate the Reynolds number. :param L: [m] surface characteristic length. :param v: [m/s] fluid velocity relative to the object. :param nu: [m2/s] fluid kinematic viscosity. :returns: float
auxi/tools/transportphenomena/dimensionlessquantities.py
def Re(L: float, v: float, nu: float) -> float: """ Calculate the Reynolds number. :param L: [m] surface characteristic length. :param v: [m/s] fluid velocity relative to the object. :param nu: [m2/s] fluid kinematic viscosity. :returns: float """ return v * L / nu
def Re(L: float, v: float, nu: float) -> float: """ Calculate the Reynolds number. :param L: [m] surface characteristic length. :param v: [m/s] fluid velocity relative to the object. :param nu: [m2/s] fluid kinematic viscosity. :returns: float """ return v * L / nu
[ "Calculate", "the", "Reynolds", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/dimensionlessquantities.py#L66-L77
[ "def", "Re", "(", "L", ":", "float", ",", "v", ":", "float", ",", "nu", ":", "float", ")", "->", "float", ":", "return", "v", "*", "L", "/", "nu" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Ra
Calculate the Ralleigh number. :param L: [m] heat transfer surface characteristic length. :param Ts: [K] heat transfer surface temperature. :param Tf: [K] bulk fluid temperature. :param alpha: [m2/s] fluid thermal diffusivity. :param beta: [1/K] fluid coefficient of thermal expansion. :param nu...
auxi/tools/transportphenomena/dimensionlessquantities.py
def Ra(L: float, Ts: float, Tf: float, alpha: float, beta: float, nu: float ) -> float: """ Calculate the Ralleigh number. :param L: [m] heat transfer surface characteristic length. :param Ts: [K] heat transfer surface temperature. :param Tf: [K] bulk fluid temperature. :param alpha: [m2...
def Ra(L: float, Ts: float, Tf: float, alpha: float, beta: float, nu: float ) -> float: """ Calculate the Ralleigh number. :param L: [m] heat transfer surface characteristic length. :param Ts: [K] heat transfer surface temperature. :param Tf: [K] bulk fluid temperature. :param alpha: [m2...
[ "Calculate", "the", "Ralleigh", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/dimensionlessquantities.py#L80-L102
[ "def", "Ra", "(", "L", ":", "float", ",", "Ts", ":", "float", ",", "Tf", ":", "float", ",", "alpha", ":", "float", ",", "beta", ":", "float", ",", "nu", ":", "float", ")", "->", "float", ":", "return", "g", "*", "beta", "*", "(", "Ts", "-", ...
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Nu
Calculate the Nusselt number. :param L: [m] heat transfer surface characteristic length. :param h: [W/K/m2] convective heat transfer coefficient. :param k: [W/K/m] fluid thermal conductivity. :returns: float
auxi/tools/transportphenomena/dimensionlessquantities.py
def Nu(L: float, h: float, k: float) -> float: """ Calculate the Nusselt number. :param L: [m] heat transfer surface characteristic length. :param h: [W/K/m2] convective heat transfer coefficient. :param k: [W/K/m] fluid thermal conductivity. :returns: float """ return h * L / k
def Nu(L: float, h: float, k: float) -> float: """ Calculate the Nusselt number. :param L: [m] heat transfer surface characteristic length. :param h: [W/K/m2] convective heat transfer coefficient. :param k: [W/K/m] fluid thermal conductivity. :returns: float """ return h * L / k
[ "Calculate", "the", "Nusselt", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/dimensionlessquantities.py#L105-L116
[ "def", "Nu", "(", "L", ":", "float", ",", "h", ":", "float", ",", "k", ":", "float", ")", "->", "float", ":", "return", "h", "*", "L", "/", "k" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
Sh
Calculate the Sherwood number. :param L: [m] mass transfer surface characteristic length. :param h: [m/s] mass transfer coefficient. :param D: [m2/s] fluid mass diffusivity. :returns: float
auxi/tools/transportphenomena/dimensionlessquantities.py
def Sh(L: float, h: float, D: float) -> float: """ Calculate the Sherwood number. :param L: [m] mass transfer surface characteristic length. :param h: [m/s] mass transfer coefficient. :param D: [m2/s] fluid mass diffusivity. :returns: float """ return h * L / D
def Sh(L: float, h: float, D: float) -> float: """ Calculate the Sherwood number. :param L: [m] mass transfer surface characteristic length. :param h: [m/s] mass transfer coefficient. :param D: [m2/s] fluid mass diffusivity. :returns: float """ return h * L / D
[ "Calculate", "the", "Sherwood", "number", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/transportphenomena/dimensionlessquantities.py#L119-L130
[ "def", "Sh", "(", "L", ":", "float", ",", "h", ":", "float", ",", "D", ":", "float", ")", "->", "float", ":", "return", "h", "*", "L", "/", "D" ]
2dcdae74154f136f8ca58289fe5b20772f215046
valid
PolynomialModelT.create
Create a model object from the data set for the property specified by the supplied symbol, using the specified polynomial degree. :param dataset: a DataSet object :param symbol: the symbol of the property to be described, e.g. 'rho' :param degree: the polynomial degree to use :...
auxi/tools/materialphysicalproperties/polynomial.py
def create(dataset, symbol, degree): """ Create a model object from the data set for the property specified by the supplied symbol, using the specified polynomial degree. :param dataset: a DataSet object :param symbol: the symbol of the property to be described, e.g. 'rho' ...
def create(dataset, symbol, degree): """ Create a model object from the data set for the property specified by the supplied symbol, using the specified polynomial degree. :param dataset: a DataSet object :param symbol: the symbol of the property to be described, e.g. 'rho' ...
[ "Create", "a", "model", "object", "from", "the", "data", "set", "for", "the", "property", "specified", "by", "the", "supplied", "symbol", "using", "the", "specified", "polynomial", "degree", "." ]
Ex-Mente/auxi.0
python
https://github.com/Ex-Mente/auxi.0/blob/2dcdae74154f136f8ca58289fe5b20772f215046/auxi/tools/materialphysicalproperties/polynomial.py#L45-L70
[ "def", "create", "(", "dataset", ",", "symbol", ",", "degree", ")", ":", "x_vals", "=", "dataset", ".", "data", "[", "'T'", "]", ".", "tolist", "(", ")", "y_vals", "=", "dataset", ".", "data", "[", "symbol", "]", ".", "tolist", "(", ")", "coeffs", ...
2dcdae74154f136f8ca58289fe5b20772f215046