@qbraid-core/compute/README.md

Client for the qBraid Compute service.

<img align="right" width="100" alt="qbraid" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid.png">

# [@qbraid-core/compute](https://qbraid.github.io/qbraid-core-js/modules/_qbraid-core_compute.html)

[![Stable][preview-stability]](https://qbraid.github.io/qbraid-core-js/#launch-stages)
[![npm](https://img.shields.io/npm/v/@qbraid-core/compute?color=blue)](https://npm.im/@qbraid-core/compute)

Client for the qBraid Compute Manager.

## Installation

```bash
npm install @qbraid-core/compute
```

## Usage Example

### V1 API (Recommended)

```typescript
import { QbraidSessionV1 } from '@qbraid-core/base';
import { ComputeManagerClientV1 } from '@qbraid-core/compute';

const session = new QbraidSessionV1('your-api-key');
const client = new ComputeManagerClientV1(session);

const profiles = await client.getProfiles();

profiles.forEach(profile => console.log(`${profile.slug} - ${profile.description}`));
```

### V0 API (Legacy)

```typescript
import { ComputeManagerClient } from '@qbraid-core/compute';

const client = new ComputeManagerClient();

const profiles = await client.getComputeManager('your-email');

profiles.forEach(profile => console.log(`${profile.slug} - ${profile.description}`));
```

## License

This software is proprietary and subject to the terms of the [qBraid Commercial Software License](https://qbraid.github.io/qbraid-core-js/#license).

[stable-stability]: https://img.shields.io/badge/stability-stable-green
[preview-stability]: https://img.shields.io/badge/stability-preview-orange
[deprecated-stability]: https://img.shields.io/badge/stability-deprecated-red