Skip to main content

Tools for simulating and analyzing the spillover between online and offline activities

Project description

Online–Offline Spillover

QR Code

O2O is a Python package that quantifies mutual spillover between online and offline events, showing how activity in one arena can influence and be influenced by the other. Generating realistic synthetic data, it lets you prototype analyses before working with sensitive records. Using a bivariate Hawkes process, O2O delivers clear estimates of both the strength and direction of these reciprocal effects, whether you are examining social-media dynamics alongside real-world incidents or any other paired event streams.

Installation

  • I highly recommend installing Python and the required dependencies in a virtual environment such as Conda. On Unix-based systems (Linux, macOS), Python is often tied to critical system functions, so modifying the system-wide Python installation can be risky. To install Conda:

  • Visit the Miniconda download page and download the appropriate installer for your operating system.

  • Follow the installation instructions.

  • Once installed, create and activate a dedicated environment

conda create -n o2o_env python=3.11
conda activate o2o_env
  • Once your environment is activated, install the required dependencies:
pip install numpy pandas matplotlib nest_asyncio

Then install CmdStan via conda.

conda install -c conda-forge cmdstan cmdstanpy

This is to avoid manual build issues and ensures CmdStan is precompiled and avoids needing make or compiler setup during install.

  • Once you install all the dependencies, you can install the package using
pip install o2o-process
  • API documentation is provided in O2O_API_documentation.pdf in the docs directory.

Usage

After installing the package, you can run its demo using the command:

o2o-demo

where you will be prompted to specify:

  • The number of users
  • The time window of interest (in days)

Note: To avoid generating empty synthetic data, use a minimum of 20 days (T = 20). Smaller values may not yield meaningful or sufficient activity data.

You can also run the demo from a Jupyter Notebook (demo.ipynb). To access it, clone the GitHub repository:

git clone https://github.com/younesszs/O2O.git

Note for Windows users

Stan models require a C++ compiler and the make build tool, neither of which are included by default on Windows. Installing and configuring these tools (e.g., g++, make, and a Unix-like shell) can be complex and error-prone due to differences between Unix-based systems and Windows. In fact, Windows' built-in Command Prompt (cmd.exe) and PowerShell do not support Unix commands by default. But tools like Stan, make, and cmdstanpy often assume they’re running in a Unix-style shell. This is why I highly recomment for Windows users to use Google Colab, a free, browser-based Python environment that runs on Linux and includes all necessary tools to compile and run Stan models out of the box. To do that follow the steps:

!pip install numpy pandas matplotlib nest_asyncio
  • Then install Stan using
import cmdstanpy
cmdstanpy.install_cmdstan()
  • Install the package:
!pip install o2o-process
  • Finally, you can run the O2O demo through
from o2o.demo import main
main()
  • You can also use the included Jupyter Notebook demo.ipynb directly in Colab:

Open In Colab

Note: Make sure to uncomment and run the first cell before executing the rest of the notebook. It installs all required dependencies.

The package performs the following:

1. Generates synthetic timestamp data

  • Simulates timestamps for both online and offline user events.

2. Estimates spillover effects

  • Calculates the influence of one event type (online/offline) on the other and its corresponding 95% confidence interval.
  • Decay rates and their 95% confidence intervals.
  • The percentage of events caused by the other type.
  • Estimates for the baseline intensities online and offline for each user as well as their corresponding 95% confidence interval.

3. Summarizes user activity

  • Computes the total number of online and offline events per user.
  • Plots the coupled online–offline intensity over time for each user.

Model

The model is a bivariate Hawkes process that can be described by the conditional intensities

$$ \lambda_1^{\text{user}} = \mu_1^{\text{user}} + \sum\limits_{k:t>t_k^1}^{N_\text{user}^1} \alpha_{11}\gamma_{11} e^{-\gamma_{11}(t-t_k^1)} + \sum\limits_{k:t>t_k^2}^{N^2_\text{user}} \alpha_{12}\gamma_{12} e^{-\gamma_{12}(t-t_k^2)} $$ $$ \lambda_2^{\text{user}} = \mu_2^{\text{user}} + \sum\limits_{k:t>t_k^1}^{N^1_\text{user}} \alpha_{21}\gamma_{21} e^{-\gamma_{21}(t-t_k^1)} + \sum\limits_{k:t>t_k^2}^{N^2_\text{user}} \alpha_{22}\gamma_{22} e^{-\gamma_{22}(t-t_k^2)}, $$

where:

  • Online activity (e.g., hostile posts) is indexed by 1.
  • Offline activity (e.g., shootings) is indexed by 2.
  • $\alpha_{ij}$: expected number of type-i events triggered by an initial type-j event.
  • $\gamma_{ij}$: decay rate of influence from type $j$ to type $i$
  • $\mu^{\text{user}} = [\mu_1, \mu_2]$: baseline intensities per user

Acknowledgement

  • This work was supported in part by AFOSR grant FA9550-22-1-0380.

  • This package is based on:

John Leverso, Youness Diouane, George Mohler, "Measuring Online–Offline Spillover of Gang Violence Using Bivariate Hawkes Processes", Journal of quantitative criminology, 2025.

Feedback and contributions

I am always open to improving this software! Feel free to open an issue, submit a pull request, or suggest enhancements.

If you find this project useful, feel free to star it to help others discover it.

Thanks for using O2O!

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

o2o_process-3.9.26.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

o2o_process-3.9.26-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file o2o_process-3.9.26.tar.gz.

File metadata

  • Download URL: o2o_process-3.9.26.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for o2o_process-3.9.26.tar.gz
Algorithm Hash digest
SHA256 3cd966d240ba64e01560735ad5602cdecc6cac457525271d7d1fb83573a70c46
MD5 3a4bbfc96bef7cd220b99a045ad27d3e
BLAKE2b-256 9377cf80f6dd7ade706e1975789e20980cbf9c9137ec54c870a6d765ccd1a0a0

See more details on using hashes here.

File details

Details for the file o2o_process-3.9.26-py3-none-any.whl.

File metadata

  • Download URL: o2o_process-3.9.26-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for o2o_process-3.9.26-py3-none-any.whl
Algorithm Hash digest
SHA256 3ab388257e598153bcc9dd3ce7e7fa2e070859319ade5dfb876abc098631ca58
MD5 4ba441941ed4bcf3a9be8db66b0394bb
BLAKE2b-256 4d6c67b916b7491e1ec494143e3ea0706917545f7bc0fff7656ce72f10ac009b

See more details on using hashes here.

Supported by

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