Merge branch 'main' into stuart/motivation

docs/introduction.md

@@ -12,9 +12,9 @@ Rather than binding coverage to each DUT monitor, Bucket creates a coverage tree
 <br>
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/trace_from_dut__dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/trace_from_dut__light.png">
-  <img alt="Image demonstrating collecting trace data from a DUT, collating it in the testbench, before passing it to Bucket" src="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/trace_from_dut__dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/trace_from_dut__dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/trace_from_dut__light.png">
+  <img alt="Image demonstrating collecting trace data from a DUT, collating it in the testbench, before passing it to Bucket" src="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/trace_from_dut__dark.png">
 </picture>
 
 <br>
@@ -24,9 +24,9 @@ Since Bucket coverage is independent from the simulator, and the testbench, it c
 <br>
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/trace_from_log__dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/trace_from_log__light.png">
-  <img alt="Image demonstrating collecting trace data from a log parser, reforming the trace data, before passing it to Bucket" src="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/trace_from_log__dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/trace_from_log__dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/trace_from_log__light.png">
+  <img alt="Image demonstrating collecting trace data from a log parser, reforming the trace data, before passing it to Bucket" src="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/trace_from_log__dark.png">
 </picture>
 
 <br>

docs/viewing_coverage.md

@@ -48,15 +48,15 @@ python -m bucket write html --sql-path ./example.db --output index.html
 You can then open the created HTML file in your preferred browser.
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Main__dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Main__light.png">
-  <img alt="Screenshot showing an example covertree loaded into the Bucket viewer" src="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Main__dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Main__dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Main__light.png">
+  <img alt="Screenshot showing an example covertree loaded into the Bucket viewer" src="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Main__dark.png">
 </picture>
 
 Above you can see the initial window when opening. The whole coverage tree is shown along with various hit statistics.
 |Statistic| Descrption|
 |--|--|
-|Goal Targets| Total number all bucket targets|
+|Goal Targets| Total number of all bucket targets|
 |Goal Hits | Total number of hits (capped at each bucket's target)
 |Buckets target | Number of targets (not their value, excluding illegal and ignore)|
 |Buckets Hit | Number of buckets with at least 1 hit|
@@ -65,26 +65,26 @@ Above you can see the initial window when opening. The whole coverage tree is sh
 On the left, the navigation menu shows the coverage tree, which can be expanded/collapsed as necessary or searched.
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Search__dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Search__light.png">
-  <img alt="Screenshot showing searching the covertree for the word 'chew'" src="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Search__dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Search__dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Search__light.png">
+  <img alt="Screenshot showing searching the covertree for the word 'chew'" src="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Search__dark.png">
 </picture>
 
 ---
 If you click on a coverpoint, the Bucket viewer shows all buckets, the goals, number of hits and hit percentage.
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Coverpoint__dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Coverpoint__light.png">
-  <img alt="Screenshot showing an example coverpoint" src="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Coverpoint__dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Coverpoint__dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Coverpoint__light.png">
+  <img alt="Screenshot showing an example coverpoint" src="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Coverpoint__dark.png">
 </picture>
 
 Each of the axis columns and goal names can be filtered to only display the buckets you are interested in. Each column can also be sorted.
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Filter__dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Filter__light.png">
-  <img alt="Screenshot showing an example coverpoint" src="https://raw.githubusercontent.com/vypercore/bucket/stuart/doc_update/.github/images/Filter__dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Filter__dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Filter__light.png">
+  <img alt="Screenshot showing an example coverpoint" src="https://raw.githubusercontent.com/vypercore/bucket/main/.github/images/Filter__dark.png">
 </picture>
 
 ---

example/example.py

@@ -74,14 +74,14 @@ def run(db_path: Path):
     print("\n-------------------------------------------------------")
     print("This is the coverage with 100 samples:")
     print(
-        f"To view this coverage in detail please run: python -m bucket read --sql-path example_file_store --points --record {rec_ref_a}"
+        f"To view this coverage in detail please run: python -m bucket write console --sql-path example_file_store.db --points --record {rec_ref_a}"
     )
     ConsoleWriter().write(reading_a)
     print(
         "\nThis is the coverage from 2 regressions. One with 100 samples, and one with 500:"
     )
     print(
-        f"To view this coverage in detail please run: python -m bucket read --sql-path example_file_store --points --record {rec_ref_merged}"
+        f"To view this coverage in detail please run: python -m bucket write console --sql-path example_file_store.db --points --record {rec_ref_merged}"
     )
     ConsoleWriter().write(merged_reading)