Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To exit the JupyterLab server, press `Ctrl+C` in the terminal where the server i

**Prerequisites:**

- Python 3.9 or higher installed on your machine.
- Python 3.11 or higher installed on your machine.

!!! note

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/api-full.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For a curated, example-driven API guide, see **[api.md](api.md)**.
> - **[CLI Reference](cli.md)** - Command-line interface
> - **[DSL Reference](dsl.md)** - YAML syntax guide

**Generated from source code on:** July 29, 2025 at 17:52 UTC
**Generated from source code on:** August 06, 2025 at 16:18 UTC

**Modules auto-discovered:** 53

Expand Down Expand Up @@ -88,7 +88,7 @@ Args:
optional "blueprints" + "network".

Returns:
Network: The fully expanded Network object with all nodes and links.
Network: The expanded Network object with all nodes and links.

---

Expand Down Expand Up @@ -1198,7 +1198,7 @@ Attributes:
demand (float): The total demand volume (default=0.0).
demand_placed (float): The portion of this demand that has been placed so far.
flow_policy_config (Optional[FlowPolicyConfig]): The routing/placement policy config.
flow_policy (Optional[FlowPolicy]): A fully constructed FlowPolicy instance.
flow_policy (Optional[FlowPolicy]): A constructed FlowPolicy instance.
If provided, it overrides flow_policy_config.
mode (str): Expansion mode for generating sub-demands.
attrs (Dict[str, Any]): Additional arbitrary attributes.
Expand Down Expand Up @@ -2452,7 +2452,7 @@ Attributes:

Workflow step for basic node and link statistics.

Computes and stores comprehensive network statistics including node/link counts,
Computes and stores network statistics including node/link counts,
capacity distributions, cost distributions, and degree distributions. Supports
optional exclusion simulation and disabled entity handling.

Expand Down Expand Up @@ -2745,7 +2745,7 @@ Attributes:
**Methods:**

- `export_summary(self) -> 'Dict[str, Any]'`
- Export comprehensive summary for serialization.
- Export summary for serialization.
- `flow_keys(self) -> 'List[str]'`
- Get list of all flow keys in results.
- `get_envelope(self, flow_key: 'str') -> 'CapacityEnvelope'`
Expand Down Expand Up @@ -2815,7 +2815,7 @@ Attributes:
- `component_impact_distribution(self) -> 'pd.DataFrame'`
- Get component impact distribution as DataFrame.
- `export_summary(self) -> 'Dict[str, Any]'`
- Export comprehensive summary for serialization.
- Export summary for serialization.
- `flow_keys(self) -> 'List[str]'`
- Get list of all flow keys in results.
- `get_failure_pattern_summary(self) -> 'pd.DataFrame'`
Expand Down
2 changes: 1 addition & 1 deletion ngraph/blueprints.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def expand_network_dsl(data: Dict[str, Any]) -> Network:
optional "blueprints" + "network".

Returns:
Network: The fully expanded Network object with all nodes and links.
Network: The expanded Network object with all nodes and links.
"""
# 1) Parse blueprint definitions
blueprint_map: Dict[str, Blueprint] = {}
Expand Down
4 changes: 2 additions & 2 deletions ngraph/lib/flow_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ def _reoptimize_flow(

Args:
flow_graph: The network graph.
flow_index: The key identifying the flow to re-optimize.
flow_index: The key identifying the flow to update.
headroom: Additional volume to accommodate on the new path.

Returns:
Expand Down Expand Up @@ -453,7 +453,7 @@ def place_demand(
f"Maximum iteration limit ({self.max_total_iterations}) exceeded in place_demand."
)

# If the flow can accept more volume, attempt to create or re-optimize.
# If the flow can accept more volume, attempt to create or update.
if (
target_flow_volume - flow.placed_flow >= base.MIN_FLOW
and not self.static_paths
Expand Down
4 changes: 2 additions & 2 deletions ngraph/monte_carlo/results.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def get_failure_pattern_summary(self) -> pd.DataFrame:
return pd.DataFrame(data)

def export_summary(self) -> Dict[str, Any]:
"""Export comprehensive summary for serialization.
"""Export summary for serialization.

Returns:
Dictionary with all results data in serializable format
Expand Down Expand Up @@ -364,7 +364,7 @@ def get_failure_pattern_summary(self) -> pd.DataFrame:
return pd.DataFrame(data)

def export_summary(self) -> Dict[str, Any]:
"""Export comprehensive summary for serialization.
"""Export summary for serialization.

Returns:
Dictionary with all results data in serializable format
Expand Down
2 changes: 1 addition & 1 deletion ngraph/traffic_demand.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class TrafficDemand:
demand (float): The total demand volume (default=0.0).
demand_placed (float): The portion of this demand that has been placed so far.
flow_policy_config (Optional[FlowPolicyConfig]): The routing/placement policy config.
flow_policy (Optional[FlowPolicy]): A fully constructed FlowPolicy instance.
flow_policy (Optional[FlowPolicy]): A constructed FlowPolicy instance.
If provided, it overrides flow_policy_config.
mode (str): Expansion mode for generating sub-demands.
attrs (Dict[str, Any]): Additional arbitrary attributes.
Expand Down
2 changes: 1 addition & 1 deletion ngraph/workflow/network_stats.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Workflow step for basic node and link statistics.

Computes and stores comprehensive network statistics including node/link counts,
Computes and stores network statistics including node/link counts,
capacity distributions, cost distributions, and degree distributions. Supports
optional exclusion simulation and disabled entity handling.

Expand Down