Skip to main content

FireFinder+ event detection

Project description

firefinder

A small, standalone FireFinder+ implementation with the same core logic used in at Geocene, plus lightweight preprocessing helpers.

FireFinder+ Events

Install

From PyPI:

pip install firefinder

Local editable install while developing:

pip install -e .

Usage

import pandas as pd
from firefinder import prepare_timeseries, fire_detector_v2, group_events

df = pd.read_csv("metrics.csv")
df = prepare_timeseries(df, correction="false")
df = fire_detector_v2(df)

events = group_events(df)
print(events.head())

If your timestamps are epoch milliseconds:

import pandas as pd
from firefinder import prepare_timeseries, fire_detector_v2, group_events

df = pd.read_json("data.json")
df["timestamp"] = pd.to_datetime(df["timestamp"], unit="ms", utc=True, errors="coerce")
df = prepare_timeseries(df, correction="false")
df = fire_detector_v2(df)
events = group_events(df)
print(events.head())

Testing

pip install -e .[test]
python -m pytest

Required columns

  • timestamp
  • value
  • sensor_type_id (required if correction="true")

Notes

  • prepare_timeseries mirrors the cleaning behavior from the original lambda processor.
  • correction="true" uses ambient sensor_type_id=9 and stove sensor_type_id=1 when computing ambient-corrected values.
  • You can pass a custom sensors mapping into prepare_timeseries to support additional stove sensor IDs.

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

firefinder-0.1.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

firefinder-0.1.1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file firefinder-0.1.1.tar.gz.

File metadata

  • Download URL: firefinder-0.1.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for firefinder-0.1.1.tar.gz
Algorithm Hash digest
SHA256 73041fd2d72f08b14a42d60e3bee8e4064bd2f4c5fc0534c4171d66a0ddc0fde
MD5 03204012ec7d3af36ad7fa0139d5ca3d
BLAKE2b-256 c03c0899f64d564cb9902f3220462fd032f813887955c8025584302da6e442f0

See more details on using hashes here.

File details

Details for the file firefinder-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: firefinder-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for firefinder-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cc8548d325822f284ba8c1f9d5f5cfc31eb85238b541ca94a924b7dae172dc58
MD5 e2fb90b7214ab85b681b71f4831e155e
BLAKE2b-256 35fe0db5a28c8cee5e7d0a2e944f1c0423be5c63c441a0c85053b55c6279347a

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