WASIC

WASIC is a Python project that provides basic features for managing various data inputs and tasks concering serial instruments. This README includes instructions for installation and usage on Windows and Linux (Debian/Ubuntu).

Table of Contents

• Requirements
• Installation
  • Windows
  • Linux (Debian/Ubuntu)
• Usage
• Structure
• Contributing
• License

Requirements

Make sure you have the following tools installed:

• Git: Required to clone the repository.
• Python: A recent version of Python is required (Python 3.13+ recommended).
• Package Manager:
  • Windows: Chocolatey
  • Linux: apt

Recommendations

On Windows, one shall uninstall USBTMC drivers of USB instruments and use WINUSB drivers. View pyvisa-py doc

Installation

Windows

1. Install Chocolatey (if not already installed):

   Open a PowerShell window with administrator privileges and run:

   Set-ExecutionPolicy Bypass -Scope Process -Force; \
   [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12; \
   iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

2. Install Git and Python using Chocolatey:

   choco install git -y
   choco install python -y

3. Clone the WASIC repository:

   git clone https://github.com/darderik/WASIC.git
   cd WASIC

4. Install the required Python dependencies:

   pip install -r requirements.txt

Linux (Debian/Ubuntu)

1. Update the system:

   sudo apt update
   sudo apt upgrade -y

2. Install Git and Python:

   sudo apt install git python3 python3-pip -y

3. Install libusb (required for USB detection with pyusb):

   sudo apt install libusb-1.0-0-dev -y

4. Clone the WASIC repository:

   git clone https://github.com/darderik/WASIC.git
   cd WASIC

5. Install the required Python dependencies:

   pip3 install -r requirements.txt

Usage

After completing the installation, you can run the project with:

• On Windows:

  python main.py

• On Linux:

  python3 main.py

Structure

Contributing

Contributions are welcome! Follow these steps to contribute:

1. Fork the repository on GitHub.

2. Create a new branch for your feature or bugfix:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m "Description of the feature or bugfix"

4. Push to the newly created branch:

   git push origin feature-name

5. Open a Pull Request on the original repository.

License

This project is licensed under the MIT License. See the LICENSE file for more details.