Metadata-Version: 2.1
Name: scenario-generator
Version: 0.1.0
Summary: Scenario generator for understanding Filecoin dynamics
Home-page: https://github.com/protocol/scenario-generator
Author: Kiran Karra, Tom Mellan
Author-email: kiran.karra@protocol.ai, tom.mellan@protocol.ai
License: MIT License
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: numpyro
Requires-Dist: jax
Requires-Dist: mechaFIL

### Purpose
This repository generates scenarios modeling variations in miner behavior.  The scenarios generate time-indexed vectors of the following indicators of miner behavior:
  - rb_onboard_power
  - renewal_rate
  - filplus_rate

The scenarios can be fed to the filecoin-mecha-twin module to understand the effect of these parameters on indicators such as:
  - Baseline crossing
  - Miner ROI
  - etc ...

We can generate four classes of scenarios:
1. Static
2. Curated scenario
3. Forecasting
    * MCMC forecasting
    * AI based forecasting

