> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amans.place/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

**AmbisonicsPy** is a lightweight Python framework for producing spatial audio. It provides a robust set of classes and tools that give users the flexibility to generate ambisonic sound.

## Quickstart

<Steps>
  <Step title="Install The Package">
    ```shellscript theme={null}
    git clone https://github.com/notcolumbus/ambisonicPy.git
    cd ambisonicPy
    pip install -e .
    ```
  </Step>

  <Step title="Start Creating">
    ```python theme={null}
    from ambisonicPy import Speaker, SoundStage
    import numpy as np

    stage = SoundStage(output_format='binaural', ambi_order=1)
    s1 = Speaker("Creep.mp3")
    s1.add_effect((0, 30), {"type": "move", "start": (np.pi/2, np.pi/2, 1.0), "end": (np.pi * 1.5, np.pi/2, 1.0)})
    stage.add_speaker(s1)
    stage.render(output_path="output.wav")

    ```
  </Step>
</Steps>