Skip to content

Commit

Permalink
Add docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
romainsacchi committed Oct 19, 2024
1 parent 6ddc7f2 commit e32a556
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions premise/incremental.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,18 @@


class IncrementalDatabase(NewDatabase):
"""
Class for creating an incremental database. Incremental databases allow measuring the
effects of sectoral updates. The class inherits from the NewDatabase class.
"""
def update(self, sectors: [str, list, None] = None) -> None:
"""
Update the database with the specified sectors.
:param sectors: A list of sectors to update. If None, all sectors will be updated incrementally.
:type
"""

sector_update_methods = {
"biomass": {
Expand Down Expand Up @@ -139,6 +150,9 @@ def write_increment_db_to_brightway(
filepath: str = None,
file_format: str = "excel",
) -> None:
"""
Write the superstructure database to a Brightway2 database.
"""

self.write_superstructure_db_to_brightway(
name, filepath, file_format, preserve_original_column=True
Expand Down

0 comments on commit e32a556

Please sign in to comment.