# hydra-framework

> Distributed computing for Node.js.

Latest version **0.0.3** (published 2020-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install hydra-framework
pnpm add hydra-framework
yarn add hydra-framework
bun add hydra-framework
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-12-19 |
| First published | 2020-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | onwd |
| Maintainers | onwd |

## Links

- npm: https://www.npmjs.com/package/hydra-framework
- Repository: https://github.com/onwd/hydra
- Homepage: https://github.com/onwd/hydra#readme
- Issues: https://github.com/onwd/hydra/issues
- npm.io page: https://npm.io/package/hydra-framework

## Dependencies (1)

- [ws](https://npm.io/package/ws.md) ^7.4.1

## Recent versions

- 0.0.3 (latest) — 2020-12-19
- 0.0.2 — 2020-12-19
- 0.0.1 — 2020-12-19

## README

# Hydra

Hydra is a distributed computing framework for Node.js and browsers. It provides a way to distribute calculation of some arbitrary function `f(x)` over arbitrary space `S` between many computation nodes (browsers or other Node.js processes) connected to master node via websockets.

## Install

```bash
$ yarn add hydra-framework
```

## Usage

### Master

1. Create a task:

```ts
// master/tasks/example-task.ts

import { Space, Task } from 'hydra-framework';

function f(x: number): boolean {
  return x * x === 64;
}

const space = new Space({
  values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
});

export const task = new Task({ f, space });
```

2. Create `Master` instance and start the server.

```ts
// master/index.ts

import { Master } from 'hydra-framework';
import { task } from './tasks/example-task';

const master = new Master({ task });

master.start();
```

### Worker

Create `Worker` instance and connect to `Master`.

```ts
import { NodeWebsocketTransport, Worker } from 'hydra-framework';

const worker = new Worker({
  transport: new NodeWebsocketTransport({
    url: 'ws://localhost:9000'
  })
});

worker.start();
```

## Concept

Hydra provides the following entities:
  - **Master**:
    - stores `Task` definition as well as algorithm to generate `Space` and sub-`Spaces`;
    - handles incoming connections from `Workers` and stores their current work state;
    - provides the `Task` definition to `Workers` as well as sub-`Spaces` they should work on;
    - stores the `Task` completion state.
  - **Worker**:
    - connects to `Master` via `Transport` and requests a `Task` definition and a sub-`Space` to work on;
    - works on a `Task` using provided definition and a sub-`Space`;
    - responds to `Master` with calculation result.
  - **Transport**:
    - allows to use `BrowserWebsocketTransport` or `NodeWebsocketTransport` depending on the environment.
  - **Task**:
    - stores `f(x)` and a `Space`.
  - **Space**:
    - stores `type` of the `Space`, `values` array or a value generator function.

---
_Source: https://npm.io/package/hydra-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._