README.md

---
title: Hexachords
emoji: 🌍
colorFrom: pink
colorTo: pink
sdk: gradio
sdk_version: 5.21.0
app_file: app.py
pinned: false
license: mit
short_description: simple generation of hexachords
---

# Hexachords

A musical composition tool that generates and manipulates hexachords - six-note musical structures.
This Hugging Face Space provides an interactive interface for exploring and creating music with hexachords.
Collaboration with Jean-Louis Hennequin who uses hexachords for film music composition.

## Features

- Generate hexachords based on musical parameters
- (soon) Create musical compositions using hexachordal structures
- (soon) Export compositions to MIDI format
- (soon) Interactive web interface for real-time experimentation

## Installation & Setup

To run this project locally:

1. Clone the repository:
   ```bash
   git clone https://huggingface.co/spaces/fpachet/hexachords
   cd hexachords
   ```

2. Install dependencies:
   ```bash
   pip install -r requirements.txt
   ```

3. Download a soundfont:
   - You'll need a soundfont (.sf2) file for audio playback
   - Place it in the root directory as `soundfont.sf2`
   - Note: The soundfont file is not included in the repository due to size limitations

## Usage

1. Local Development:
   ```bash
   python app.py
   ```

2. Web Interface:
   - Visit the Hugging Face Space to use the online version
   - No installation required for the web interface

## Important Note

This project requires a soundfont (.sf2) file for audio playback. Due to file size limitations, the soundfont is not included in the repository. You'll need to:

1. Download a compatible soundfont file
2. Rename it to `soundfont.sf2`
3. Place it in the project root directory

Recommended soundfonts:
- General User GS
- FluidR3_GM

## License

This project is licensed under the MIT License - see the LICENSE file for details.