Skip to content

Quick Start Guide

Jump to bottom
Raphael Constantinis edited this page Jul 23, 2025 · 1 revision

Quick Start Guide

Get up and running with entropic_measurement in just a few minutes!

Installation

Prerequisites

  • Python 3.8 or higher
  • pip (Python package installer)

Install from PyPI

pip install entropic-measurement

Install from Source

git clone https://github.com/rconstant1/entropic_measurement.git
cd entropic_measurement
pip install -e .

Basic Usage

Simple Example

import entropic_measurement as em

# Create a measurement instance
measurement = em.Measurement()

# Add some data points
data = [1.2, 2.3, 1.8, 2.1, 1.9]
measurement.add_data(data)

# Calculate entropy
entropy = measurement.calculate_entropy()
print(f"Entropy: {entropy}")

Advanced Example

import entropic_measurement as em
import numpy as np

# Generate sample data
data = np.random.normal(0, 1, 1000)

# Create measurement with custom parameters
measurement = em.Measurement(
    bins=50,
    method='histogram'
)

# Process the data
measurement.add_data(data)
results = measurement.analyze()

print(f"Entropy: {results.entropy}")
print(f"Information: {results.information}")
print(f"Complexity: {results.complexity}")

Key Features

  • Easy Installation: Install via pip or from source
  • Simple API: Intuitive methods for entropy calculation
  • Multiple Methods: Support for various entropy estimation techniques
  • Flexible Input: Works with lists, numpy arrays, and pandas Series
  • Comprehensive Analysis: Beyond basic entropy calculation

Next Steps

Need Help?

Clone this wiki locally