# @rapidsai/core

> Shared CMake modules, TypeScript configurations, and C++ headers for RAPIDS node native modules

Latest version **22.12.1** (published 2023-06-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @rapidsai/core
pnpm add @rapidsai/core
yarn add @rapidsai/core
bun add @rapidsai/core
```

Provides the commands `rapidsai-install-native-module`, `rapidsai-merge-compile-commands`.

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 22.12.1 |
| Published | 2023-06-05 |
| First published | 2022-08-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 258.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 210 |
| Author | NVIDIA, Inc. |
| Maintainers | rapidsai-owner, raydouglass, jacobtomlinson |

## Links

- npm: https://www.npmjs.com/package/@rapidsai/core
- Repository: https://github.com/rapidsai/node
- Homepage: https://github.com/rapidsai/node/tree/main/modules/core#readme
- Issues: https://github.com/rapidsai/node/issues
- npm.io page: https://npm.io/package/@rapidsai/core

## Dependencies (6)

- [getos](https://npm.io/package/getos.md) 3.2.1
- [tslib](https://npm.io/package/tslib.md) ^2.3.0
- [bindings](https://npm.io/package/bindings.md) ^1.5.0
- [cmake-js](https://npm.io/package/cmake-js.md) 7.2.1
- [cross-env](https://npm.io/package/cross-env.md) 7.0.3
- [@types/node](https://npm.io/package/@types/node.md) ^15.0.0

## Recent versions

- 22.12.1 (latest) — 2023-06-05
- 22.12.0 — 2023-05-23
- 22.8.2 — 2023-02-28
- 22.8.1 — 2022-09-20
- 22.8.0 — 2022-09-02
- 22.6.2 — 2022-08-17
- 22.6.1 — 2022-08-16
- 22.6.0 — 2022-08-16

## README

# <div align="left"><img src="https://rapids.ai/assets/images/rapids_logo.png" width="90px"/>&nbsp; node-rapids</div>

[`node-rapids`](https://github.com/rapidsai/node) is a collection of Node.js native addons for the [NVIDIA RAPIDS](https://rapids.ai/) suite of GPU-accelerated data-science and ETL libraries on Linux and WSL2.

* [`@rapidsai/rmm`](https://github.com/rapidsai/node/tree/main/modules/rmm) - [RAPIDS Memory Manager](https://github.com/rapidsai/rmm)
* [`@rapidsai/cudf`](https://github.com/rapidsai/node/tree/main/modules/cudf) - [RAPIDS GPU DataFrame](https://github.com/rapidsai/cudf)
* [`@rapidsai/cuml`](https://github.com/rapidsai/node/tree/main/modules/cuml) - [RAPIDS Machine Learning Library](https://github.com/rapidsai/cuml)
* [`@rapidsai/cugraph`](https://github.com/rapidsai/node/tree/main/modules/cugraph) - [RAPIDS Graph Analytics Library](https://github.com/rapidsai/cugraph)
* [`@rapidsai/cuspatial`](https://github.com/rapidsai/node/tree/main/modules/cuspatial) - [RAPIDS Accelerated GIS Library](https://github.com/rapidsai/cuspatial)

`node-rapids` includes limited bindings to other necessary native APIs:

* [`@rapidsai/cuda`](https://github.com/rapidsai/node/tree/main/modules/cuda) - Interact with GPUs via the [CUDA Runtime APIs](https://developer.nvidia.com/cuda-toolkit)
* [`@rapidsai/glfw`](https://github.com/rapidsai/node/tree/main/modules/glfw) - Create platform-agnostic native windows with OpenGL contexts via [GLFW](https://github.com/glfw/glfw)
* [`@rapidsai/webgl`](https://github.com/rapidsai/node/tree/main/modules/webgl) - Provides a [`WebGL2RenderingContext`](https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext) via [OpenGL ES](https://www.khronos.org/opengles)

`node-rapids` uses the ABI-stable [`N-API`](https://nodejs.org/api/n-api.html) via [`node-addon-api`](https://github.com/nodejs/node-addon-api), so the libraries work in node and Electron without recompiling.

See the [API docs](https://rapidsai.github.io/node/) for detailed information about each module.

## Getting started

Due to native dependency distribution complexity, pre-packaged builds of the `node-rapids` modules are presently only available via our [public docker images](https://github.com/orgs/rapidsai/packages/container/package/node). See [USAGE.md](https://github.com/rapidsai/node/tree/main/USAGE.md) for more details.

## Getting involved

See [DEVELOP.md](https://github.com/rapidsai/node/blob/main/DEVELOP.md) for details on setting up a local dev environment and building the code.

We want your input! Join us in the [#node-rapids channel](https://rapids-goai.slack.com/archives/C0237JMVBRS) in the [RAPIDS-GoAI Slack workspace](https://rapids-goai.slack.com).

## Tracking Progress

You can review [BINDINGS.md](https://github.com/rapidsai/node/blob/main/BINDINGS.md) to see which bindings have been completed for each of the RAPIDS libraries.

## Demos

Check out our [demos](https://github.com/rapidsai/node/tree/main/modules/demo) to see various visualization and compute capabilities:

* [Library of deck.gl demos in OpenGL](https://github.com/rapidsai/node/tree/main/modules/demo/deck/)
* [Cross filtering millions of rows with cuDF](https://github.com/rapidsai/node/tree/main/modules/demo/client-server)
* [Simulating & rendering with cuGraph](https://github.com/rapidsai/node/tree/main/modules/demo/graph/)
* [Querying millions of points with cuSpatial](https://github.com/rapidsai/node/tree/main/modules/demo/spatial/)

## License

This work is licensed under the [Apache-2.0 license](https://github.com/rapidsai/node/tree/main/LICENSE).

---

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