ramp_database.testing.setup_ramp_kit_ramp_data

ramp_database.testing.setup_ramp_kit_ramp_data(ramp_config, problem_name, force=False, depth=None, mock_html_conversion=False)

Clone ramp-kit and ramp-data repository and setup it up.

Parameters

ramp_configdict

The configuration file containing the information about a RAMP event. It corresponds to the configuration generated with ramp_utils.generate_ramp_config.

problem_namestr

The name of the problem.

forcebool, default is False

Whether or not to overwrite the RAMP kit and data repositories if they already exists.

depthint, default=None

the depth parameter to pass to git clone. Use depth=1 for a shallow clone (faster).

mock_html_conversionbool, default=False

Whether we should call nbconvert to create the HTML notebook. If True, the file created will be an almost empty html file.