Contains independent scripts/demos.
This following README provide guidance on understanding tools used in fpmms.
Follow these steps to set up the project:
fpmms uses submodules, which need to be initialized:
git submodule update --init --recursive
The project uses Poetry for dependency management:
- If you don't have Poetry installed, install it first.
- Update and install the project dependencies:
poetry update
poetry install
Run the 0. download_data.ipynb
notebook located in the nbs
folder to download and prepare the data required for the project.
To understand the workings of the FPMMS project, refer to the following notebooks:
-
Tools Evaluation: Location: fpmms/nbs/Tools_Evaluation.ipynb Description: This notebook outlines how the dataset is built and evaluates the tools used in the project.
-
Costing Analysis: Location: fpmms/nbs/costing_analysis.ipynb Description: This notebook provides an analysis of the costs associated with running different tools within the project.
-
Traders Profitability Analysis: Location: fpmms/nbs/profitability_analysis.ipynb Description: This notebook provided analysis on profitability of the traders. Before running the notebbok, you could either run
profitability.py
script or get the required data by running0. download_data.ipynb