Skip to content
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -775,13 +775,16 @@ Shared by all assemblies (`WoundJellyRoll`, `FlatWoundJellyRoll`, `PunchedStack`
|---|---|---|
| `thickness` | mm | Overall jelly roll thickness |
| `width` | mm | Overall jelly roll width |
| `cathode_notch_alignment_position` | mm or `None` | Cathode notch-center position from the left edge of the unrotated pressed mandrel's straight racetrack section; generates paired ±z notches on each complete turn; `None` keeps scalar spacing |
| `anode_notch_alignment_position` | mm or `None` | Anode notch-center position from the same straight-section edge with paired ±z notches; arrangement follows `laminate.electrode_orientation` |

**`FlatWoundJellyRoll` — additional read-only:**

| Property | Unit | Description |
|---|---|---|
| `pressed_radius` | mm | Pressed mandrel radius |
| `pressed_straight_length` | mm | Pressed mandrel straight length |
| `thickness_aware_notch_data` | dict | Calculated centers, center spacings, and gaps by electrode |

**`PunchedStack` / `ZFoldStack` — additional settable:**

Expand Down Expand Up @@ -944,6 +947,12 @@ Shared by all current collector types.
| `a_side_coated_section` | (mm, mm) | (start, end) of A-side coating |
| `b_side_coated_section` | (mm, mm) | (start, end) of B-side coating |

**`NotchedCurrentCollector` — additional settable:**

| Property | Unit | Description |
|---|---|---|
| `tab_center_positions` | list of mm or `None` | Optional uneven centers measured from the foil leading edge |

**Tabbed CCs** (`NotchedCurrentCollector`, `TabWeldedCurrentCollector`, `PunchedCurrentCollector`) — **additional settable:**

| Property | Unit | Description |
Expand All @@ -965,6 +974,10 @@ Shared by all current collector types.
| `insulation_area` | cm² | Total insulation area |
| `top_side` | str | Which side ('a'/'b') faces up |
| `total_height` | mm | Total height including tab (tabbed types) |
| `calculated_tab_center_positions` | list of mm | Calculated centers in the collector coordinate system (`NotchedCurrentCollector`) |
| `tab_center_spacings` | list of mm | Consecutive center-to-center spacings (`NotchedCurrentCollector`) |
| `tab_gaps` | list of mm | Consecutive edge-to-edge gaps (`NotchedCurrentCollector`) |
| `n_tabs` | int | Number of tab segments, including a clipped legacy end tab (`NotchedCurrentCollector`) |

### Separator Properties

Expand Down Expand Up @@ -1061,6 +1074,7 @@ All visualization methods return [Plotly](https://plotly.com/python/) `go.Figure
| Method | Availability | Description |
|---|---|---|
| `get_spiral_plot()` | `WoundJellyRoll`, `FlatWoundJellyRoll` | Spiral winding path visualization |
| `plot_notch_alignment()` | `FlatWoundJellyRoll` | Racetrack cross-section with paired ±z notch centers |
| `get_top_down_view()` | All assemblies | Top-down view of the assembly |
| `get_side_view()` | All assemblies | Side view of the assembly |
| `get_capacity_plot()` | All assemblies | Assembly-level capacity curves |
Expand Down
Loading
Loading