Jacdac widget for Jupyter Lab
Перейти к файлу
Tom Ball 6649b3a4b6
Update README.md
2024-10-01 13:32:48 -07:00
.github/workflows move to node 14.x 2021-09-21 10:55:48 -07:00
.vscode experiment with notebook icons 2020-09-10 01:51:08 -07:00
binder Merge branch 'main' of https://github.com/microsoft/jupyter-jacdac into main 2020-10-14 18:56:15 +02:00
examples/gesture formatting 2021-08-31 09:04:50 -07:00
src updated iframe settings 2021-09-10 11:07:38 -07:00
style hosting jacdac in extension 2020-09-11 00:33:47 -07:00
.gitignore Add sample gesture recognition notebook 2020-10-14 17:57:33 +02:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2020-08-27 05:46:16 -07:00
LICENSE Initial LICENSE commit 2020-08-27 05:46:17 -07:00
README.md Update README.md 2024-10-01 13:32:48 -07:00
SECURITY.md Initial SECURITY.md commit 2020-08-27 05:46:20 -07:00
jupyter-jacdac.code-workspace fix path 2020-09-08 21:15:55 +02:00
package.json chore(release): 1.1.4 [skip ci] 2021-05-24 14:39:08 +00:00
tsconfig.json adding initial drop 2020-08-27 14:49:48 +02:00
yarn.lock patch: ping binder 2020-09-21 23:25:35 -07:00

README.md

NOTE: Jacdac has moved to the organization https://github.com/jacdac

jupyter-jacdac

Binder

This project contains a Microsoft Jacdac extension for Jupyter Lab. The extension allows to collect data from embedded devices and push ML model back into them.

Requirements

  • JupyterLab >= 2.0

Install

The extensions package is hosted on NPMJS.

jupyter labextension install jupyter-jacdac

Uninstall

jupyter labextension uninstall jupyter-jacdac

Contributing

The extension essentially loads https://microsoft.github.io/jacdac-ts and interacts with this web site via IFrame messages. The UI integration into JupyterLab is kept to an absolute minimum.

Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn in lieu of jlpm below.

# Clone the repo to your local environment
# Move to jacdac directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.