Skip to content

Models and Methods used in the Mat3ra Workflow Ecosystem

License

Notifications You must be signed in to change notification settings

Exabyte-io/mode.js

Repository files navigation

npm version License: Apache

mode.js

MOdel DEfinitions in JS - mode.js - houses model entity definitions for use in the Mat3ra platform.

Installation

For usage within a javascript project:

npm install @exabyte-io/mode.js

For development:

git clone https://github.com/Exabyte-io/mode.js.git

Contribution

This repository is an open-source work-in-progress and we welcome contributions.

We regularly deploy the latest code containing all accepted contributions online as part of the Mat3ra.com platform, so contributors will see their code in action there.

See ESSE for additional context regarding the data schemas used here.

Useful commands for development:

# run linter without persistence
npm run lint

# run linter and save edits
npm run lint:fix

# compile the library
npm run transpile

# run tests
npm run test

MoDe

The MoDe package is used in conjunction with the ADe package to define top-level parameters present in Subworkflow units in the WoDe package ecosystem. The entities provided by MoDe are: