speckle_automate_jupyter_example/README.md

Speckle Automate Jupyter Notebook Template

An example Speckle Automate Function using a Jupyter Notebook.

This is intended to be a template from which you can base your own Speckle Automate Function.

Usage

Please open and edit the function.ipynb file in a Jupyter Notebook environment. This might be a GitHub Codespace, Visual Studio Code, or a local Jupyter Notebook installation.

Instructions for use are included within the function.ipynb file.

If you wish to add more external dependencies, please add them to the pyproject.toml file, within the [tool.poetry.dependencies] section.