gaspype.species#

gaspype.species(pattern='*', element_names=[], use_regex=False)#

Returns a alphabetically sorted list of all available species filtered by a pattern if supplied

Parameters:
  • pattern (str) – Optional filter for specific molecules. Placeholder characters: # A number including non written ones: ‘C#H#’ matches ‘CH4’; $ Arbitrary element name; * Any sequence of characters

  • element_names (str | list[str]) – restrict results to species that contain only the specified elements. The elements can be supplied as list of strings or as comma separated string.

  • use_regex (bool) – using regular expression for the pattern

Return type:

list[str]

Returns:

List of species