@tscircuit/capacity-autorouter 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/index.d.ts +818 -0
- package/dist/index.js +4184 -0
- package/dist/index.js.map +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# capacity-
|
|
1
|
+
# @tscircuit/capacity-autorouter
|
|
2
2
|
|
|
3
3
|
A high-density PCB autorouter library for node.js and TypeScript projects. Part of the [tscircuit project](https://github.com/tscircuit/tscircuit) · [discord](https://tscircuit.com/join) · [twitter](https://x.com/seveibar) · [try tscircuit online](https://tscircuit.com)
|
|
4
4
|
|
|
@@ -7,7 +7,7 @@ Check out this [short youtube explanation of this autorouter](https://youtu.be/M
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
bun add capacity-
|
|
10
|
+
bun add @tscircuit/capacity-autorouter
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Usage as a Library
|
|
@@ -15,7 +15,7 @@ bun add capacity-node-autorouter
|
|
|
15
15
|
### Basic Usage
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import { CapacityMeshSolver } from "capacity-
|
|
18
|
+
import { CapacityMeshSolver } from "@tscircuit/capacity-autorouter"
|
|
19
19
|
|
|
20
20
|
// Create a solver with SimpleRouteJson input
|
|
21
21
|
const solver = new CapacityMeshSolver(simpleRouteJson)
|
|
@@ -103,10 +103,10 @@ You can provide optional configuration parameters to the solver:
|
|
|
103
103
|
const solver = new CapacityMeshSolver(simpleRouteJson, {
|
|
104
104
|
// Optional: Manually set capacity planning depth (otherwise automatically calculated)
|
|
105
105
|
capacityDepth: 7,
|
|
106
|
-
|
|
106
|
+
|
|
107
107
|
// Optional: Set the target minimum capacity for automatic depth calculation
|
|
108
108
|
// Lower values result in finer subdivisions (higher depth)
|
|
109
|
-
targetMinCapacity: 0.5
|
|
109
|
+
targetMinCapacity: 0.5,
|
|
110
110
|
})
|
|
111
111
|
```
|
|
112
112
|
|