Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andstor/diffuse

3D simulator for simulating diffusion
https://github.com/andstor/diffuse

Last synced: 1 day ago
JSON representation

3D simulator for simulating diffusion

Awesome Lists containing this project

README

        

# diffuse
diffuse is a 3D simulator for simulating diffusion, built with [three.js](https://threejs.org).

## Environments in which to use diffuse
diffuse supports normal browsers.

## Main
```text
dist/
└── diffuse.js (UMD, default)
```

## Getting started
### Installation

```html

```

You can download the [latest standalone JavaScript files (ES5)](https://github.com/andstorh/diffuse/releases/latest)

### Usage
#### Syntax
```
new DIFFUSE(options)
```

#### Examples
##### Window
```js
const DSIM = new DIFFUSE();
```
[⬆ back to top](#diffuse)

## Build instructions

Clone a copy of the main diffuse git repo by running:

```bash
git clone git://github.com/andstor/diffuse.git
```

Enter the diffuse directory and run the build script:
```bash
npm run build
```

## Credits:
**Developers:** [André Storhaug](https://github.com/andstor)

## License
diffuse is licensed under the [MIT License](https://github.com/andstor/diffuse/blob/master/LICENSE).

[⬆ back to top](#diffuse)