pyiron_base.state.install module

pyiron_base.state.install.install_dialog(silently=False)

pyiron_base.state.install.install_pyiron(config_file_name='~/.pyiron', zip_file='resources.tar.gz', project_path='~/pyiron/projects', resource_directory='~/pyiron/resources', giturl_for_zip_file='https://github.com/pyiron/pyiron-resources/releases/latest/download/resources.tar.gz', git_folder_name='resources')

Function to configure the pyiron installation.

Parameters:

• config_file_name (str) – configuration file name - usually ~/.pyiron

• zip_file (str) – name of the compressed file

• project_path (str) – the location where pyiron is going to store the pyiron projects

• resource_directory (str) – the location where the resouces (executables, potentials, …) for pyiron are stored.

• giturl_for_zip_file (str/None) – url for the zipped resources file on github. (Default points to pyiron’s github resource repository. If None, leaves the resources directory empty.)

• git_folder_name (str) – name of the extracted folder