ImJoy Core

The ImJoy core library -- a sandboxed plugin framework for building computational web applications.

Usage

You can load the ImJoy core into your website or web application, such that you can call another ImJoy plugins.

Or, you can inject the ImJoy runtime into your web application, such that it can be loaded as an ImJoy window plugin.

See integration with ImJoy-Core for more details.

ImJoy Core API

See imjoy-core api for the detailed definition.

Development

git clone https://github.com/imjoy-team/imjoy-core.git
cd imjoy-core
npm run install

# test
npm run test

# build
npm run build

For project maintainers, the publish is automatic with the current github actions setup. Here are the steps:

• Bump the version in package.json, say 0.20.0
• Commit the changes with commit message Release 0.20.0

Issues

This repo only accept PR, please post issue to the ImJoy repo: https://github.com/imjoy-team/ImJoy/issues.

Citation

Please cite our paper on Nature Methods (https://www.nature.com/articles/s41592-019-0627-0, free access: https://rdcu.be/bYbGO ):

Ouyang, W., Mueller, F., Hjelmare, M. et al. ImJoy: an open-source computational platform for the deep learning era. Nat Methods (2019) doi:10.1038/s41592-019-0627-0

@article{ouyang2019imjoy,
  title={ImJoy: an open-source computational platform for the deep learning era},
  author={Ouyang, W. and Mueller, F. and Hjelmare, M. and others},
  journal={Nat Methods},
  year={2019},
  doi={10.1038/s41592-019-0627-0}, 
}

Code of Conduct

Help us keep the ImJoy community open and inclusive. Please read and follow our Code of Conduct.

License

MIT License