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.2.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.2-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: firefinder-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 196eb9b598c396192fd3e3042f71823e08f7b6aea821172904aaa4b93235e634
MD5 5ec90d14c60cba5abc6a5eca4001b73b
BLAKE2b-256 efff37e60f9134c91a9c69cf573000946d403909987bcbe8e36981f84a5bd85a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: firefinder-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9600668693a8409939ac18a3ef4f14ae04f18a97b1b5e1759287d144cfe06476
MD5 cb88cde226975fddbf9e472ffd2f254f
BLAKE2b-256 55745f0363f0c1addb0949b9e4bb04a4c1fee449f53c166438223612bbe8f0ba

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