find_all_gambit_bits Namespace Reference

Functions
def	get_bits_from_directory_list (gambit_directory)
def	write_list_to_yaml (list_of_bits, output_file, yaml_key="gambit_bits")

Variables
	parser = argparse.ArgumentParser(description=)
	required
	True
	help
	args = parser.parse_args()

Function Documentation

get_bits_from_directory_list()

def find_all_gambit_bits.get_bits_from_directory_list

(

gambit_directory

)

Get Gambit Bits.

Return a sorted list of directory names with "Bit" in the name. 
This effectively generates a list of all available Bits in Gambit based on the established nameing scheme inside the Gambit repository.

Args:
    gambit_directory (str): Directory to search in. To work properly this has to be the Gambit source directory.

Returns:
    list: sorted list of Gambit Bits

Definition at line 8 of file find_all_gambit_bits.py.

def get_bits_from_directory_list(gambit_directory):
    """Get Gambit Bits.

    Return a sorted list of directory names with "Bit" in the name. 
    This effectively generates a list of all available Bits in Gambit based on the established nameing scheme inside the Gambit repository.

    Args:
        gambit_directory (str): Directory to search in. To work properly this has to be the Gambit source directory.

    Returns:
        list: sorted list of Gambit Bits
    """
    return sorted(set([directory for directory in os.listdir(gambit_directory) if "Bit" in directory]))

write_list_to_yaml()

def find_all_gambit_bits.write_list_to_yaml	(		list_of_bits,
			output_file,
			yaml_key = "gambit_bits"
	)

Write given list to a yaml file.

Args:
    list_of_bits list(str): List of Gambit Bits.
    output_file (str): Path/name for the output file.
    yaml_key (str): Key which is used to write the yaml file.

Definition at line 23 of file find_all_gambit_bits.py.

def write_list_to_yaml(list_of_bits, output_file, yaml_key="gambit_bits"):
    """Write given list to a yaml file.

    Args:
        list_of_bits list(str): List of Gambit Bits.
        output_file (str): Path/name for the output file.
        yaml_key (str): Key which is used to write the yaml file.
    """
    with open(output_file, "w+") as f:
        yaml.dump({
            yaml_key: list_of_bits
        }, f)

Variable Documentation

args

find_all_gambit_bits.args = parser.parse_args()

Definition at line 41 of file find_all_gambit_bits.py.

Referenced by daFunk::FunkBase.assert_args(), Gambit::DecayTable::Entry.BF(), Gambit::DecayTable::Entry.BF_error(), Gambit::DecayTable::Entry.BF_with_error(), Gambit::Scanner::Function_Base< ret(args...)>.check_for_switch_to_alternate_min_LogL(), Gambit::DecayTable::Entry.construct_key(), Gambit::Utils.dummy_function(), Gambit::Scanner::Plugins::Plugin_Main_Interface_Base< ret(args...)>.enterMain(), daFunk.eraseArg(), Gambit::gambit_core.ff_backend_diagnostic(), daFunk.func(), daFunk.func_fromThreadsafe(), daFunk.funcM(), daFunk.funcM_fromThreadsafe(), Gambit::Scanner::Function_Base< ret(args...)>.Function_Base(), Gambit::Options.getNames(), daFunk::FunkBase.getNArgs(), Gambit::Options.getNode(), Gambit::Options.getOptions(), daFunk::FunkBase.getSingl(), Gambit::Options.getValue(), Gambit::DescriptionDatabase.getValue(), Gambit.getVariadicNode(), Gambit::Options.getVector(), daFunk::FunkBase.gsl_integration(), Gambit::DecayTable::Entry.has_channel(), Gambit::Options.hasKey(), Gambit::DescriptionDatabase.hasKey(), Gambit.initSet(), Gambit.initVector(), Gambit::Scanner.input_variadic_vector(), Gambit::Scanner::Scanner_Plugin_Function< ret(args...)>.main(), Gambit::Scanner::Multi_Scanner_Plugin_Function< ret(args...)>.main(), main(), Gambit::Scanner::Plugins::Plugin_Interface< T >.operator()(), Gambit::Scanner::Plugins::Plugin_Interface< ret(args...)>.operator()(), Gambit::Scanner::Function_Deleter< ret(args...)>.operator()(), Gambit::BEfunction_bucket< TYPE(*)(ARGS...), TYPE, ARGS... >.operator()(), Gambit::backend_functor< TYPE(*)(ARGS...), TYPE, ARGS... >.operator()(), Gambit::backend_functor< void(*)(ARGS...), void, ARGS... >.operator()(), Gambit::Scanner::scan_ptr< ret(args...)>.operator=(), Gambit::Options.Options(), Gambit::Scanner::Plugins::Plugin_Interface< T >.Plugin_Interface(), Gambit::Scanner::Plugins::Plugin_Interface< ret(args...)>.Plugin_Interface(), Gambit::Scanner::scan_ptr< ret(args...)>.scan_ptr(), daFunk::FunkBase.set(), Gambit::DecayTable::Entry.set_BF(), Gambit::ASCIItableReader.setcolnames(), Gambit.stringifyVariadic(), Gambit::Scanner::Function_Base< ret(args...)>.type(), daFunk.vec(), Gambit::backend_functor< TYPE(*)(ARGS...), TYPE, ARGS... >.~backend_functor(), Gambit::backend_functor< void(*)(ARGS...), void, ARGS... >.~backend_functor(), and daFunk::FunkBase.~FunkBase().

help

find_all_gambit_bits.help

Definition at line 39 of file find_all_gambit_bits.py.

Referenced by daFunk::FunkBase.getNArgs(), and main().

parser

find_all_gambit_bits.parser = argparse.ArgumentParser(description=)

Definition at line 38 of file find_all_gambit_bits.py.

required

find_all_gambit_bits.required

Definition at line 39 of file find_all_gambit_bits.py.

True

find_all_gambit_bits.True

Definition at line 39 of file find_all_gambit_bits.py.