A simple and self-constrained example that using the augurs npm package

[shenxiangzhuang]

Hi, thanks for your awesome work firstly! I'm wondering is there a simple and self-constrained example that using the npm package augurs?

I want to know how to use this package in a new javascript project. I see the example at https://github.com/grafana/augurs/blob/main/demo/clustering.js, but which is using the file in dist rather than the npm package. Sorry for that I'm not familiar with javascript, so I don't know how to transform the example from "dist files" to "npm package". Any suggestion will be appreciated!

[sd2k]

This is definitely an area that's lacking! I'll make a note to update the README for the npm package.

In the meantime there is a test package which imports from the npm package which might be helpful. Let me know if that's any use.

[shenxiangzhuang]

Thanks for your timely reply, and the test package helps a lot! I can use the package and run it now.

There is another minor question about the code:

augurs/js/testpkg/clustering.test.ts

Lines 1 to 9 in 9652eba

	import { readFileSync } from "node:fs";
	import { DbscanClusterer, initSync as initClusteringSync } from '@bsull/augurs/clustering';
	import { Dtw, initSync as initDtwSync } from '@bsull/augurs/dtw';
	import { describe, expect, it } from 'vitest';
	initClusteringSync({ module: readFileSync('node_modules/@bsull/augurs/clustering_bg.wasm') });
	initDtwSync({ module: readFileSync('node_modules/@bsull/augurs/dtw_bg.wasm') });

It seems we have to specify the wasm file path by hand when we use it, for example initClusteringSync({ module: readFileSync('node_modules/@bsull/augurs/clustering_bg.wasm') });. I'm wondering is there any other more convenient method that we can use to load the wasm module?

[sd2k]

Ah, ordinarily you shouldn't have to do that, that's just there because I wanted to set up the tests more explicitly.

In most cases you can do something like:

import init, { Dtw } from '@bsull/augurs/dtw';

async function run() {
    await init().then(() => console.log('augurs dtw initialized'));

    Dtw.euclidean().distanceMatrix([ ... ]);
}

The init async function should handle loading and initializing the WASM for you using import.meta (at least in a browser context).

[shenxiangzhuang]

I got it. Thanks a lot!