bw2io.remote#

Module Contents#

Functions#

get_projects(→ dict)

install_project(project_key[, project_name, ...])

Install an existing Brightway project archive.

Attributes#

PROJECTS_BW2

PROJECTS_BW25

cache_dir

bw2io.remote.get_projects(update_config: Optional[bool] = True) → dict[source]#
bw2io.remote.install_project(project_key: str, project_name: Optional[str] = None, projects_config: Optional[dict] = get_projects(), url: Optional[str] = 'https://files.brightway.dev/', overwrite_existing: Optional[bool] = 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 repository

  • url (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

bw2io.remote.PROJECTS_BW2[source]#
bw2io.remote.PROJECTS_BW25[source]#
bw2io.remote.cache_dir[source]#