Welcome to the KALMUS's notebook tutorials!
This folder contains the IPython notebooks that walk you through how to interact with the KALMUS package.
To run these notebooks, please install the latest version of Jupyter Lab (Installation Instruction for JupyterLab) and the latest version of KALMUS package (Installation Guide for KALMUS).
When running the notebooks, make sure you have downloaded the whole notebooks folder or cloned the project on your local machine. Then, start the Jupyter Lab inside the notebooks folder using command:
$ jupyter lab
Content:
- Notebook Figures
- Notebook Example Data: You are welcome to put your own data inside this folder when walking through the examples in notebooks!
- Notebook Utility: Plot utility for you to visualize certain processes occurring during the barcode generation.
- Notebook Guide for how to interact with Graphic User Interface
- Notebook Guide for how to interact with Application Programming Interface
- Notebook Guide for Advanced usage of Application Programming Interface (how to create your own Barcode Visualization)
- Markdown Guide for how to interact with Command-line Interface
We provide the markdown version of user guides for kalmus' Command-line interface and Graphic user interface. The rendered markdown tutorials can be read directly on the GitHub.
Content:
- Markdown Guide for how to interact with Graphic User Interface
- Markdown Guide for how to interact with Command-line Interface