Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
02bwilson committed Jul 16, 2023
1 parent ddf7b77 commit d453b63
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<div style="text-align: center"> <h1> Oscilloground </h1>

[![Oscilloground](https://github.com/02bwilson/Oscilloground/actions/workflows/python-app.yml/badge.svg)](https://github.com/02bwilson/Oscilloground/actions/workflows/python-app.yml)

Oscilloground is a Python program that provides a user-friendly interface to combine different signals and visualize them in the time and frequency domains. It utilizes PyQt6 for the graphical user interface and SciPy for signals. With Oscilloground, you can add custom signals and use various operators to create complex signal combinations for analysis and visualization. </div>

# Features

Combine different signals using various operators.
Real-time visualization of signals in the time and frequency domain.
Easily adjust signal parameters and observe their effects.

# Prerequisites

Make sure you have the following software installed before running Oscilloground:

Python (version 3.6 or higher)
PyQt6
SciPy

# Installation

Clone this repository and install the required dependencies:

```git clone https://github.com/yourusername/Oscilloground.git```

```cd Oscilloground```

```pip install -r requirements.txt```

# Usage

To launch Oscilloground, run the following command:

```python oscilloground.py```

# How to Use

Launch the Oscilloground application.
In the GUI, you'll see options to add various standard signals (e.g., sine, square, sawtooth).
Select the signals you want to combine and use operators like addition, multiplication, etc., to create your desired signal composition.
Observe the real-time visualization of the resulting signal in the time and frequency domains.
Adjust signal parameters to see how it affects the combined signal.

0 comments on commit d453b63

Please sign in to comment.