docs: Update basic usage documentation page (#31)

* docs: Update Basic Usage guide and API documentation to be clearer and provide a more cohesive documentation viewing experience * ci: Remove a test from the tox config since it is not needed (doesn't work anyways) * test: Update testing settings to use unique port numbers for each parallel test environment to avoid collisions when running via tox * docs: Update docstring in example code * test: Update port used for test server * docs: Update readme to include an installation section
tektronix · Oct 1, 2024 · d3e3f76 · d3e3f76
1 parent 12a4af4
commit d3e3f76
Show file tree

Hide file tree

Showing 23 changed files with 282 additions and 325 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,14 @@ Valid subsections within a version are:
 
 Things to be included in the next release go here.
 
+### Added
+
+- Added an installation section to the main README.
+
+### Changed
+
+- Updated the documentation by moving portions from the Basic Usage page to the API docs.
+
 ---
 
 ## v1.0.0 (2024-09-20)

diff --git a/README.md b/README.md
@@ -15,23 +15,47 @@
 
 # TekHSI: Tektronix High Speed Interface
 
-`TekHSI` is a Python library that provides a low latency, high-speed data link between Tektronix scopes and host computer using gRPC. This library is designed to provide a reliable and efficient way to transfer data between devices, especially when dealing with large amounts of data.
+`TekHSI` is a Python library that provides a low latency, high-speed data link between Tektronix
+scopes and host computer using gRPC. This library is designed to provide a reliable and efficient
+way to transfer data between devices, especially when dealing with large amounts of data.
 
-With `TekHSI`, you can easily connect your Tektronix scope to other devices, such as host computers or other test equipment, and transmit data quickly and efficiently. This library is especially useful for applications that require real-time data acquisition and analysis, such as in the fields of electronics, telecommunications, and signal processing.
+With `TekHSI`, you can easily connect your Tektronix scope to other devices, such as host computers
+or other test equipment, and transmit data quickly and efficiently. This library is especially
+useful for applications that require real-time data acquisition and analysis, such as in the
+fields of electronics, telecommunications, and signal processing.
 
-`TekHSI` uses gRPC, a high-performance, open-source framework that provides a platform-independent way to communicate between applications. This means you can use `TekHSI` with any platform supporting gRPC, including Windows, Linux, and macOS.
+`TekHSI` uses gRPC, a high-performance, open-source framework that provides a platform-independent
+way to communicate between applications. This means you can use `TekHSI` with any platform
+supporting gRPC, including Windows, Linux, and macOS.
 
-## Some of the key features of `TekHSI` include:
+## Key Features
 
-1. Low latency - `TekHSI` provides a fast and efficient data link between devices, with minimal delay between data transmission and reception.
+1. Low latency - `TekHSI` provides a fast and efficient data link between devices, with minimal
+    delay between data transmission and reception.
 2. High speed - `TekHSI` can transfer large amounts of data quickly and efficiently.
-3. Easy to use - `TekHSI` is designed to be easy to use, with a simple and intuitive API that makes it easy to connect your Tektronix scope.
-4. Consistent sets - `TekHSI` guarantees that data arrives in "consistent sets." This means that data is all from the same acquisition. This is true when the instrument is stopped and when it is running. When using SCPI commands, this is only guaranteed when the instrument is stopped.
-5. Richer Synchronization - `TekHSI` allows a rich set of synchronization options. This includes accepting any arriving acquisition, accepting acquisitions with vertical or horizontal changes, or only accepting acquisitions after a certain time.
+3. Easy to use - `TekHSI` is designed to be easy to use, with a simple and intuitive API that makes
+    it easy to connect your Tektronix scope.
+4. Consistent sets - `TekHSI` guarantees that data arrives in "consistent sets." This means that
+    data is all from the same acquisition. This is true when the instrument is stopped and when it
+    is running. When using SCPI commands, this is only guaranteed when the instrument is stopped.
+5. Richer Synchronization - `TekHSI` allows a rich set of synchronization options. This includes
+    accepting any arriving acquisition, accepting acquisitions with vertical or horizontal changes,
+    or only accepting acquisitions after a certain time.
 
-In summary, if you need a reliable and efficient way to transfer data between your Tektronix scope and host computer, `TekHSI` is the library for you. With its low latency, high speed, and easy-to-use API, `TekHSI` provides a powerful solution for data acquisition and analysis.
+In summary, if you need a reliable and efficient way to transfer data between your Tektronix scope
+and host computer, `TekHSI` is the library for you. With its low latency, high speed, and
+easy-to-use API, `TekHSI` provides a powerful solution for data acquisition and analysis.
 
-## Devices with TekHSI support
+## Installation
+
+> [!IMPORTANT]
+> `TekHSI` requires a 64-bit Python installation due to its external dependencies
+
+```shell
+pip install tekhsi
+```
+
+## Device Support
 
 <div markdown="1" class="custom-table-center-cells device-support-table">
 

diff --git a/docs/additional_examples_and_pseudo_code/access_data.py b/docs/additional_examples_and_pseudo_code/access_data.py
diff --git a/docs/additional_examples_and_pseudo_code/acq_filters.py b/docs/additional_examples_and_pseudo_code/acq_filters.py
diff --git a/docs/additional_examples_and_pseudo_code/active_symbols.py b/docs/additional_examples_and_pseudo_code/active_symbols.py
diff --git a/docs/additional_examples_and_pseudo_code/blocking_methods.py b/docs/additional_examples_and_pseudo_code/blocking_methods.py
diff --git a/docs/additional_examples_and_pseudo_code/supported_data_types.py b/docs/additional_examples_and_pseudo_code/supported_data_types.py
diff --git a/docs/additional_examples_and_pseudo_code/wait_on_new_data.py b/docs/additional_examples_and_pseudo_code/wait_on_new_data.py
diff --git a/docs/additional_examples_and_pseudo_code/wait_on_next_acq.py b/docs/additional_examples_and_pseudo_code/wait_on_next_acq.py
diff --git a/docs/additional_examples_and_pseudo_code/wait_on_time.py b/docs/additional_examples_and_pseudo_code/wait_on_time.py