README.md

# LynxKite 2024

This is an experimental rewrite of [LynxKite](https://github.com/lynxkite/lynxkite). It is not compatible with the
original LynxKite. The primary goals of this rewrite are:

- Target GPU clusters instead of Hadoop clusters. We use Python instead of Scala, RAPIDS instead of Apache Spark.
- More extensible backend. Make it easy to add new LynxKite boxes. Make it easy to use our frontend for other purposes,
  configuring and executing other pipelines.

Current status: **PROTOTYPE**

## Installation

To run the backend:

```bash
pip install -r requirements.txt
PYTHONPATH=. pydantic2ts --module server.workspace --output ./web/src/apiTypes.ts
uvicorn server.main:app --reload
```

To run the frontend:

```bash
cd web
npm i
npm run dev
```