Skip to content

Available Network

The 3D page writes networks/available.json. Build loads that file. A node is node_id, location [x, y, z], and alpha, beta, gamma (ZYX degrees: α about X, β about Y, γ about Z). A segment is segment_id, location_at_end_a, location_at_end_b, and spline_control_points. Each control point is an offset from end A, in order from A to B. The console adds end A when it draws a control point. spline_points and spline_length place each stored triple in the Bezier polygon as written, in the same coordinate space as the two ends. An empty control list is a straight line.

Commands

These functions are already available in build instructions as available_network. Use them as written.

available_network.load()

Use this when a harness build needs the available network already stored in this revision.

Load the available network from disk.

If the file does not exist yet, generates a starter network from harness node instances, writes it, and returns it:

  • 0 node instances: raises ValueError.
  • 1: places that node at (0, 0, 0) and adds a node instance named far (far-2 if that name is taken) four inches in −X, at (-4, 0, 0), connected by one segment.
  • 2: places them at (0, 0, 0) and (x, 0, 0) with x a random integer in [6, 18], connected by one segment.
  • 3 or more: places a hub at (0, 0, 0) and each instance node at (r cos θ, r sin θ, 0) with r in [6, 18] and θ in [0, 359] degrees, each connected to the hub by a spoke segment.
available_network.source_context_from_path(local_path=None, lib_repo=None, relative_path=None)

Use this when a harness build needs a STEP file copied into networks/contexts/ as routing context for this harness.

Copy a STEP file into this harness as routing context.

Pass either local_path or both lib_repo and relative_path. The file is written to networks/contexts/ under its own filename, replacing a context file of that name. Other files already in contexts/ are left in place. The 3D available and chosen network pages load .step and .stp files from that folder.

Args: - local_path (str, optional): Filesystem path to a .step or .stp file. - lib_repo (str, optional): Library repository URL from repository_locations.csv. - relative_path (str, optional): Path of the STEP file under that repository.

Returns: - str: Path of the context file written into this harness.

Raises: - ValueError: If both sources are given, neither source is complete, the relative path leaves the repository, or the file is not a STEP file. - FileNotFoundError: If the source file does not exist.

available_network.source_available_network_from_project(project_mpn, project_subpath, project_repo)

Use this when a harness build should replace this revision's available network with the available network from another project.

Copy another project's available network into this harness.

The other project is the library tip (highest revision) of project_mpn under project_repo and project_subpath. Its available-network file replaces this harness's available network.

Args: - project_mpn (str): Part-number folder of the source project. - project_subpath (str): Path under the repository that contains that part number. "" when the part number sits at the repository root. - project_repo (str): Library repository URL from repository_locations.csv.

Returns: - dict: The available network that was written.

Raises: - ValueError: If project_mpn or project_repo is blank, or the subpath leaves the repository. - FileNotFoundError: If the part, its revision, or its available network file cannot be found.