0.2.7 • Published 3 years ago
@eyespace/clmath-viewer v0.2.7
clmath javascript library
Used internally at EyeSpace. Not for public consumption.
The idea here is that the viewer is now just a collection of javascript helper functions.
- The
lib
directory contains the published code - The
examples
directory contains a sample of how to use it.
Importing helper functions
import { tracesFromDac, tracesFromJfl } = from '@eyespace/clmath-viewer'
OR
const { tracesFromDac, tracesFromJfl } = require('@eyespace/clmath-viewer');
These helper functions can be used in the browser and also on a NodeJS back-end, which is useful. Plotly, on the other hand can only be used client side because it is dependent on browser only APIs.
Requirements
- Should support all DAC and JFL points files. Even files not generated by us.
- Helper functions can be composed to add functionality like reflecting and grouping traces.
- Helper functions should run on NodeJS back-end and front-end.
Development
npm install
To run unit tests:
npm run test
To develop locally using the example React viewer app:
npm run dev
Then browse to http://localhost:1234/
To develop locally using the example React blend differencing viewer app
npm run blend-dev
Then browse to http://localhost:1234/
There is an example back surface file (HRPT.v5b) and schema (HRPT_schema.json) in the samples directory.