All Functions
Function reference
All-In-One Animation Functions
| animation.animate_activity_log | Generate an animated visualization of patient flow through a system. |
Step-By-Step Functions
| prep.reshape_for_animations | Reshape event log data for animation purposes. |
| prep.generate_animation_df | Generate a DataFrame for animation purposes by adding position information to entity data. |
| animation.generate_animation | Generate an animated visualization of patient flow through a system. |
Animation Enhancers
| animation.add_repeating_overlay | Add a repeating overlay (rectangle and text) to an animated Plotly figure using traces. |
Simpy Resource Classes
| resources.VidigiResource | A simple resource class with an ID attribute for use in VidigiStore and VidigiPriorityStore. |
| resources.VidigiStore | A wrapper around SimPy’s Store that allows using a context manager pattern |
| resources.VidigiPriorityStore | An optimized SimPy priority store that eliminates delays between resource |
| resources.populate_store | Populate a SimPy Store (or VidigiPriorityStore) with VidigiResource objects. |
Event Logging Utility Functions and Classes
| logging.EventLogger |
Event Positioning Utility Functions and Classes
| utils.EventPosition | Pydantic model for a single event position. |
| utils.create_event_position_df | Creates a DataFrame for event positions from a list of EventPosition objects. |
Streamlit Utility Functions
| utils.streamlit_play_all | Programmatically triggers all ‘Play’ buttons in Plotly animations embedded in Streamlit using JavaScript. |
ciw Utility Functions
| ciw.event_log_from_ciw_recs | Given the ciw recs object, return a dataframe in the format expected by the vidigi |
legacy Functions
| resources.VidigiPriorityStoreLegacy | A SimPy store that processes requests with priority. |