Skip to content

Commit 8455027

Browse files
authored
Add testbench docs (#326)
Signed-off-by: Ruturaj Mohite <mohite.ruturaj15@gmail.com>
1 parent 89b9cd9 commit 8455027

9 files changed

Lines changed: 49 additions & 0 deletions

File tree

docs/_sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
* Chapter 7: Building Circuit Simulations within CircuitVerse
3030
* [CircuitVerse Design Process](/chapter7/1cvdesignprocess.md)
3131
* [Building Circuit Simulations within CircuitVerse Simulator](/chapter7/2buildwithcv.md)
32+
* [Testing Circuits](/chapter7/3testcircuits.md)
3233
* Chapter 8: Support Resources
3334
* [Online Forums](/chapter8/1onlineforums.md)
3435
* [FAQ](/chapter8/2cvfaq.md)

docs/chapter7/3testcircuits.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Testing CircuitVerse circuits
2+
3+
The Testbench helps you test your circuits in the simulator itself
4+
5+
### It's here in this corner
6+
7+
![drawing](../images/img_chapter7/location.jpg)
8+
9+
### Attach a test to a circuit
10+
Each circuit in a project can be attached a test, this test is saved along with your circuits. So the next time you load your circuit, the test loads with it.
11+
12+
![drawing](../images/img_chapter7/click_attach.png)
13+
14+
### Create the test using the test creator
15+
The test creator provides an intuitive UI to create tests.
16+
- Select the type of test - `Sequential` or `Combinational`
17+
- Add inputs / outputs by clicking the `+` icon next to `INPUTS` / `OUTPUTS` label.
18+
- Add another test to the group by clicking `+` icon below
19+
- Add another group by clicking `New Group`
20+
21+
For sequential tests, clock is ticked between each Group. For combinational tests, Groups are just a logical seperation between different types of tests.
22+
23+
Alternatively, you can also export the created test as CSV and edit it. You can import this CSV to attch by clicking `Import from CSV`
24+
25+
Finally,
26+
- Save and attach the test by clicking `Attach`
27+
28+
![drawing](../images/img_chapter7/make_test.png)
29+
30+
### Label your circuit elements
31+
The testbench uses the element labels to identify Input and Output elements. So make sure they are labelled the same as that in the tests.
32+
33+
Click `Validate` to make sure you have added all elements properly
34+
35+
![drawing](../images/img_chapter7/name_elements.png)
36+
37+
### Ready to go!
38+
Click the arrows next to Group / Test number to scroll through and run tests
39+
40+
![drawing](../images/img_chapter7/manual.png)
41+
42+
Click `Run All` to run all the tests in an instant
43+
44+
![drawing](../images/img_chapter7/runall.png)
45+
46+
And get detailed results!
47+
48+
![drawing](../images/img_chapter7/detailed.png)
40.6 KB
Loading
48.9 KB
Loading
86.2 KB
Loading
68.6 KB
Loading
65.4 KB
Loading
12.2 KB
Loading
73.7 KB
Loading

0 commit comments

Comments
 (0)