bw2io.remote#
Attributes#
Functions#
|
|
|
Install an existing Brightway project archive. |
Module Contents#
- bw2io.remote.get_projects(update_config: bool = True, base_url: str | None = None, filename: str | None = None) dict [source]#
- bw2io.remote.install_project(project_key: str, project_name: str | None = None, projects_config: dict | None = None, url: str | None = 'https://files.brightway.dev/', overwrite_existing: bool | None = False, __recursive: bool | None = False)[source]#
Install an existing Brightway project archive.
By default uses
https://files.brightway.dev/
as the file repository, but you can run your own.- Parameters:
project_key (str) – A string uniquely identifying a project, e.g.
ecoinvent-3.8-biosphere
.project_name (str, optional) – The name of the new project to create. If not provided will be taken from the archive file.
projects_config (dict, optional) – A dictionary that maps
project_key
values to filenames at the repositoryurl (str, optional) – The URL, with trailing slash
/
, where the file can be found.overwrite_existing (bool, optional) – Allow overwriting an existing project
__recursive (bool) – Internal flag used to determine if this function has errored out already
- Returns:
The name of the created project.
- Return type:
str