Skip to content

Commit

Permalink
Adding missing ArangoDb comment docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JBris committed Sep 10, 2024
1 parent d712337 commit 16b84f3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions deeprootgen/io/simulation_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ def s3_upload_file(file_name: str, object_name: str, bucket_name: str = "data")
def save_graph_to_db(
simulation: RootSystemSimulation, task: str, simulation_uuid: str
) -> None:
"""Save the hierarchical graph representation of the root model to ArangoDB.
Args:
simulation (RootSystemSimulation):
The root system simulation instance.
task (str):
The current simulation task.
simulation_uuid (str):
The simulation uuid.
"""
G = simulation.G.as_networkx()
collection = f"{task}-{simulation_uuid}"

Expand Down

0 comments on commit 16b84f3

Please sign in to comment.