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.4.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bursty_dynamics-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 c5220c76eb38ef693861e05009ba659a27eff054eaacb0647290c67b88a70459
MD5 1ba38739081f28df0dc81256e6def54c
BLAKE2b-256 5131af68ce0f41fa66669e453535eaea6dc46570be87ba34b3b21dbefb8dde59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bursty_dynamics-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c2cffeae345a8175c73753a78b9431529896f339e4dfb683c2e661209acc6f22
MD5 1c29368af1eb311694a0313e7e4a5dbf
BLAKE2b-256 e121f840674e5f8888dbe835e0f7a33ffeb7f03c5995836a01479200942ece7b

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