py2lispIDyOM: A Python package for IDyOM
py2lispIDyOM is an open-source Python package that serves as a unifying Python interface that simplifies and
streamlines the research workflow for running the information dynamics of music IDyOM model and analyzing output data.
It is broadly aimed at researchers conducting IDyOM-based analysis in Python.
Table of Content
Getting Started
Prerequisites
py2lispIDyOM requires IDyOM to be installed on the local machine. To start with, please read the IDyOM installation page to appropriately install IDyOM.
Installing
The code is compatible with >= Python 3.9.
It can be installed using pip or directly from the source code. Basic installation options include:
From PyPI using pip:
pip install py2lispIDyOMDownload or gitclone this repository.
Functionality and Usage
In summary, py2lispIDyOM has three main functionalities for research workflow:
Running the IDyOM
Data preprocessing
Visualizing IDyOM outputs
Please have a look at the tutorials, which guides you through all three basic functionalities of through examples.
Notebook examples
Running the IDyOM model: 1_running_IDyOM_tutorial.ipynb
Data preprocessing:
Extracting data: 2a_data_preprocessing_extracting.ipynb
Exporting data: 2b_data_preprocessing_exporting.ipynb
Visualization: 3_visualizing_outputs.ipynb
Note: I tried to make the code accessible and provide some examples in the tutorials for getting started smoothly. But there is still lots of room for better documentation, tutorials and testing. Please contact me if you have any questions or encounter bugs!