Skip to main content

bursty_dynamics is a Python package designed to facilitate the analysis of temporal patterns in longitudinal data. It provides functions to calculate the burstiness parameter (BP) and memory coefficient (MC), detect event trains, and visualise results.

Project description

PyPI Documentation DOI

bursty_dynamics is a Python package designed to facilitate the analysis of temporal patterns in longitudinal data. It provides functions to calculate the burstiness parameter (BP) and memory coefficient (MC), detect event trains, and visualise results.

This package implements the alternate burstiness parameter described in the paper ‘Measuring Burstiness for Finite Event Sequences’ by Kim, Eun-Kyeong, and Hang-Hyun Jo, and memory coefficient described in ‘Burstiness and Memory in Complex Systems’ by Goh, K.-I., and A.-L. Barabási.

Features

  • Burstiness Parameter (BP) and Memory Coefficient (MC) Calculation: Calculate BP and MC to quantify the irregularity and memory effects of event timing within longitudinal data.

  • Event Train Detection: Detect and label event trains based on user-defined criteria such as maximum inter-event time and minimum burst size.

  • Train-Level Analysis: Analyse BP and MC for detected event trains, providing insights into temporal patterns within trains of events.

  • Visualisation Tools: Visualise temporal patterns with scatter plots, histograms, kernel density estimates (KDE), and more, facilitating interpretation of analysis results.

  • User-Friendly Interface: Designed for ease of use, with clear function parameters and output formats, making it accessible to both novice and experienced users.

Installation

You can install bursty_dynamics via pip:

pip install bursty_dynamics

Usage

Here’s a quick overview of how to use the main functionalities of the package

from bursty_dynamics.scores import calculate_scores
from bursty_dynamics.trains import train_detection, train_info, train_scores

# Load your longitudinal data into a DataFrame
# df = load_data()

# calculate BP and MC
score_df = calculate_scores(df, subject_id = 'eid', time_col = 'event_dt')

For more example of usage, please take a look at examples.ipynb in the example folder.

Getting Help

For more information about bursty_dynamics, please check out:

License

License

bursty_dynamics is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or for questions, suggestions, or general discussion related to our project, please visit our GitHub Discussions page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bursty_dynamics-0.1.2.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

bursty_dynamics-0.1.2-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file bursty_dynamics-0.1.2.tar.gz.

File metadata

  • Download URL: bursty_dynamics-0.1.2.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for bursty_dynamics-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d092706fa7a55736ca9e1a6ec46dfebb0bb319cda57bead756bc72626f63009b
MD5 8efee1079d20438199553674dcf6f37c
BLAKE2b-256 2f583df0fa2d3fa8dabb8116b597984f1c8441108955acb4a54933126168d741

See more details on using hashes here.

File details

Details for the file bursty_dynamics-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for bursty_dynamics-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 190986bcfe8b2141ccc75cf063617c5c7b1b00825aeb57b8e577f488a9ba296c
MD5 9543e034fc7a78b4b95959118d2df201
BLAKE2b-256 6cbcd6f860f364f3eb79d683490414a29f59f253f75e3b5205d4d033c017ff1c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page