EVOSEAL Setup Guide¶

This guide will help you set up the EVOSEAL development environment.

Prerequisites¶

Python 3.9 or higher
Git
pip (Python package installer)

Quick Start¶

Clone the repository

git clone --recurse-submodules git@github.com:SHA888/EVOSEAL.git
cd EVOSEAL

Set up the development environment

# Make the setup script executable
chmod +x scripts/setup.sh

# Run the setup script
./scripts/setup.sh

This will:

Create a Python virtual environment
Install all dependencies
Set up Git hooks
Create a .env file from the example
Activate the virtual environment
```
source .venv/bin/activate
```
Configure environment variables Edit the .env file with your API keys and configuration:
```
cp .env.example .env
nano .env  # or use your preferred editor
```

Project Structure¶

evo-seal/
├── .github/                 # GitHub workflows and templates
├── config/                  # Configuration files
├── data/                    # Data files
├── docs/                    # Documentation
├── evoseal/                 # Main package
│   ├── core/                # Core functionality
│   ├── integration/         # Integration with DGM, OpenEvolve, SEAL (Self-Adapting Language Models)
│   └── utils/               # Utility functions
├── logs/                    # Log files
├── notebooks/               # Jupyter notebooks
├── scripts/                 # Utility scripts
├── tests/                   # Test suite
├── .env.example            # Example environment variables
├── .gitignore              # Git ignore rules
├── pyproject.toml          # Python project configuration
├── README.md               # Project documentation
└── requirements/           # Dependency files
    ├── base.txt           # Core dependencies
    ├── dev.txt            # Development dependencies
    └── test.txt           # Test dependencies

Development Workflow¶

Activate the virtual environment
```
source .venv/bin/activate
```
Run tests
```
pytest
```
Run code quality checks
```
black .
isort .
flake8
mypy .
```
Run the linter and formatter automatically before commit
```
pre-commit install
```

Contributing¶

Create a new branch for your feature or bugfix:
```
git checkout -b feature/your-feature-name
```

Make your changes and commit them:

git add .
git commit -m "Your commit message"

Push your changes to the remote repository:

git push -u origin feature/your-feature-name

Create a pull request on GitHub.

License¶

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

Last update: 2025-07-20
Created: 2025-06-17