Skip to content

Commit 8c6082f

Browse files
Create Installation.md
1 parent 8ae7794 commit 8c6082f

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

Installation.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
*This file contains the instructions for installing and running the SoundScape project on your system.*
2+
3+
## Requirements
4+
To run SoundScape, you need to have Python 3.6 or higher and pip installed on your system. You also need a microphone and speakers or headphones to interact with the soundscape.
5+
6+
## Dependencies
7+
SoundScape depends on the following Python libraries:
8+
9+
- PyAudio: for recording and playing audio
10+
- PySimpleGUI: for creating the soundscape visualization
11+
- NumPy: for numerical computations
12+
- SciPy: for signal processing
13+
- Matplotlib: for creating canvases
14+
15+
You can install these dependencies using the following command in your terminal:
16+
```
17+
pip install -r requirements.txt
18+
```
19+
20+
Alternatively, you can clone this repository and install the dependencies manually:
21+
```
22+
git clone https://github.com/Soumya-Kushwaha/SoundScape.git
23+
cd SoundScape
24+
pip install -r requirements.txt
25+
```
26+
27+
## Running the project
28+
*Soundscape consists of multiple files with different use cases:*
29+
30+
### 1. Waveform
31+
This file simply visualizes the waveform of audio detected in real time. To view the waveform, run the code:
32+
```
33+
python waveform.py
34+
```
35+
36+
### 2. Spectogram
37+
This file visualizes the spectogram of the audio detected in real time. To view the spectogram, run the code:
38+
```
39+
python spectogram.py
40+
```
41+
42+
### 3. Amplitude vs Frequency
43+
This file visualizes the amplitude v/s frequency of the audio detected in real time. To view the amplitude v/s frequency graph, run the code:
44+
```
45+
python amplitude-frequency-visualizer.py
46+
```
47+
48+
<br>
49+
50+
*These codes will open a new output window that displays the soundscape visualization. You can use your microphone to interact with the soundscape. The soundscape will change its shape, color, and movement according to the sound input.*

0 commit comments

Comments
 (0)