Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 3.35 KB

README.md

File metadata and controls

79 lines (57 loc) · 3.35 KB
Raw

Overview

The ActivityMigrator is a Python module designed for migrating activities between projects and different versions of the ecoinvent database in the Brightway framework. This tool is particularly useful when transitioning projects from older versions of ecoinvent to newer ones. It automates the process of finding equivalent activities in the new database and handles the creation of activities and their exchanges if they do not exist in the target database. Features

  • Migration between databases: Facilitates the migration of activities from one database to another, especially between different ecoinvent versions.
  • Creation of missing activities: Automatically create activities in the new database if they are not found.
  • Performance optimization: Caches results of migration attempts to enhance performance.
  • Flexible searching: Allows migration by either activity code or key.
  • Biosphere handling: Special handling for migrating biosphere activities.

NOTES:

  • Still a work in progress. You should expect some errors at this stage.
  • Tested only with bw2data version (4, 0, 'DEV33').
  • fuzzy matching is used for some biosphere exchanges with slightly different names. I would need to look into this more. In my case I had Particulates> 10 um. This is renamed to Particulate matter, > 10 um in the new biosphere database for some reason. I did not test it with other flows that might be named drastically differently which would mean that the fuzzy finder will not be able to find the equivalent flow.

Installation

To use ActivityProjectMigrator, please ensure you have Python installed along with the bw2data and fuzzywuzzy packages. You can install these packages using pip:

pip install bw2data fuzzywuzzy

Usage

First, import and initialize the ActivityProjectMigrator with your project and database names:

from migrator import ActivityProjectMigrator

migrator = ActivityProjectMigrator(
    old_db_name="OLD_DB_NAME",
    old_project_name="OLD_PROJECT_NAME",
    new_db_name="NEW_DB_NAME",
    new_project_name="NEW_PROJECT_NAME"
)

Migrating an Activity

To migrate an activity, use the migrate_activity method:

activity_code = "ACTIVITY_CODE_OR_KEY"
result = migrator.migrate_activity(
    old_activity_code=activity_code,
    create_if_not_found=True
)
  • create_if_not_found=True will create the activity in the new database if it's not found.
  • Set by_key=True to search by activity key instead of code.

Saving your database

Automatically created activities have an attribute called auto_generated, so if you would like to undo or delete all these activities, simply do the following:

db = bd.Database('new_database')
for a in db:
    if a.get('auto_generated'):
        a.delete()

TODO

  • More extensive testing.
  • Ability to create activities in a new or existing database that is not the background database (ecoinvent).

I'm only using it for a specific use case, and I only have a little time to do other things, but please let me know if you have suggestions. Or if you think something is sloppy.

Author

Haitham Ghaida - [email protected]

Contributing

Contributions to the ActivityProjectMigrator are welcome! Please submit your pull requests or issues through the GitHub repository.

License

This project is licensed under [BSD 3-Clause] - see the LICENSE file for details.