cellular-automaton 0.1.7

A cellular automaton simulation library targeting WebAssembly.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

<div align="center">
  <h1><code>cellular-automaton</code></h1>

  <p>
    <strong>A cellular automaton simulation library targeting WebAssembly.</strong>
  </p>

  <p>
    <a href="https://crates.io/crates/cellular-automaton"><img alt="Crates.io version" src="https://img.shields.io/crates/v/cellular-automaton?style=flat-square&logo=rust"></a>
    <a href="https://crates.io/crates/cellular-automaton"><img alt="Crates.io downloads" src="https://img.shields.io/crates/d/cellular-automaton?style=flat-square&label=crates.io downloads"></a>
    <a href="https://docs.rs/cellular-automaton"><img src="https://img.shields.io/badge/docs.rs-latest-blue.svg?style=flat-square" alt="docs.rs docs" /></a>
  </p>

  <p>
    <a href="https://www.npmjs.com/package/@tedbyron/cellular-automaton"><img alt="npm version (scoped)" src="https://img.shields.io/npm/v/@tedbyron/ca?style=flat-square&logo=npm"></a>
    <a href="https://www.npmjs.com/package/@tedbyron/cellular-automaton"><img alt="npm type definitions" src="https://img.shields.io/npm/types/@tedbyron/ca?style=flat-square"></a>
  </p>

  <h3>
    <a href="https://docs.rs/cellular-automaton">Rust API Docs</a>
  </h3>
</div>

## [Rust Library](https://crates.io/crates/cellular-automaton)

```toml
# Cargo.toml
[dependencies]
cellular-automaton = "0.1"
```

This crate defaults to supporting WebAssembly. To build the crate without WebAssembly support, don't use the crate's default features and build to a specific target:

```sh
cargo build --no-default-features --target x86_64-unknown-linux-gnu
```

## [JavaScript Package](https://www.npmjs.com/package/@tedbyron/ca)

```sh
# npm
npm i @tedbyron/ca

# yarn
yarn add @tedbyron/ca

# pnpm
pnpm add @tedbyron/ca
```

The npm package has:

-   A ~60kb WASM binary
-   No dependencies
-   JavaScript bindings to the WASM binary
-   TypeScript definitions

The package is built to target [`webpack`](https://webpack.js.org/) (`--target bundler`) but can be rebuilt from the Rust library for a different target:

```sh
wasm-pack build --target <bundler|nodejs|web|no-modules>
wasm-opt -Os pkg/cellular_automaton_bg.wasm -o pkg/cellular_automaton_bg.wasm
```