pyiron.base.settings.install module

pyiron.base.settings.install.install_dialog()[source]
pyiron.base.settings.install.install_pyiron(config_file_name='~/.pyiron', zip_file='resources.zip', project_path='~/pyiron/projects', resource_directory='~/pyiron/resources', giturl_for_zip_file='https://github.com/pyiron/pyiron-resources/archive/master.zip', git_folder_name='pyiron-resources-master')[source]

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) – url for the zipped resources file on github

  • git_folder_name (str) – name of the extracted folder