Implements FPP and SLE algorithms
Project description
FPP-SLE
Install
The package is publised on PyPI and installable via pip
:
pip install fpp-sle
To contribute to the project, clone and install the full development version (uses poetry for dependencies):
git clone https://github.com/engeir/fpp-sle
cd fpp-sle
poetry install
pre-commit install
Before committing new changes to a branch you can run command
nox
to run the full test suite. You will need Poetry, nox and nox-poetry installed for this.
Usage
See the examples.py script for working examples. The main classes and functions this package provide is
-
VariableRateForcing
(insidefpp
module)This is a class that inherit from the forcing generator class provided by
superposed-pulses
. The class adds a method for setting a custom function that generates arrival times given the time axis and a given number of total pulses to generate. -
get_arrival_times
(inside thefpp
module)This is a module that holds functions that draws arrival times according to some non-negative numpy array or callable, that is, the variable rate process.
-
pass_rate
(insideget_arrival_times
)Used to decorate the functions that draws arrival times from the rate function. This is the function you may want to pass in to the
set_arrival_times_function
method of theVariableRateForcing
class. It decorates functions withinget_arrival_times
staring withfrom_
. -
from_
(insideget_arrival_times
)These are generator functions that can take a callable or a numpy array as input, and returns arrival times based on the rate function. Currently only one generator function is implemented (
from_inhomogeneous_poisson_process
) which draws arrival times as if the rate was the underlying rate of a Poisson process.
-
-
sde
This module holds different implementations of stochastic differential equations. See the docstring of the individual functions for explanations.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.