# charlesg/pftk architecture

> Architecture diagram of the GitHub repository charlesg/pftk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/charlesg/pftk
- Repository: https://github.com/charlesg/pftk

## Overview

pftk is a Python finance toolkit for working with market data, constructing features, applying learning methods, simulating trades, and analyzing results. A representative workflow is to obtain or load market data, build features for analysis, simulate portfolio allocations, and review performance. The tree also includes strategy, event-study, and data-conversion/reporting capabilities. The README gives little product-level detail, and several modules are unsampled; relationships below are limited to references in the source index or shown excerpts.

Main entry points: [`pftk/pftkfeat/featutil.py`](https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/featutil.py) (Feature preparation), [`pftk/pftktools/report.py`](https://github.com/charlesg/pftk/blob/master/pftk/pftktools/report.py) (Performance reporting), [`pftk/pftkutil/data_access.py`](https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/data_access.py) (Market data access), [`pftk/pftktools/csv2fund.py`](https://github.com/charlesg/pftk/blob/master/pftk/pftktools/csv2fund.py) (CSV fund conversion)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_data["Market data"]
  node_market_data[("Market data access<br/>[data_access.py]")]
  node_date_utils["Date utilities<br/>[qsdateutil.py]"]
  node_market_data_tools["Market data tools"]
end

subgraph group_analysis["Features and learning"]
  node_feature_definitions["Feature calculations<br/>[features.py]"]
  node_feature_pipeline["Feature preparation<br/>[featutil.py]"]
  node_feature_classes["Feature classes<br/>[classes.py]"]
  node_knn["KNN learner<br/>[kdtknn.py]"]
  node_other_learners["Other learners"]
  node_time_series["Time-series utilities<br/>[tsutil.py]"]
end

subgraph group_trading["Trading and studies"]
  node_strategies["Trading strategies<br/>[strategies.py]"]
  node_trade_sim["Trade simulation<br/>[tradesim.py]"]
  node_event_study["Event studies"]
end

subgraph group_reporting["Conversion and reporting"]
  node_csv_conversion["CSV fund conversion<br/>[csv2fund.py]"]
  node_performance_report["Performance reporting<br/>[report.py]"]
  node_fund_metrics["Fund metrics<br/>[fundutil.py]"]
end

node_external_data(("Market data sources"))

node_feature_pipeline -->|"uses features"| node_feature_definitions
node_feature_pipeline -->|"uses classes"| node_feature_classes
node_feature_pipeline -->|"trains learner"| node_knn
node_feature_pipeline -->|"uses data"| node_market_data
node_feature_pipeline -->|"uses dates"| node_date_utils
node_feature_pipeline -->|"uses series"| node_time_series
node_market_data -.->|"loads market data"| node_external_data
node_trade_sim -->|"uses series"| node_time_series
node_performance_report -->|"uses data"| node_market_data
node_performance_report -->|"uses dates"| node_date_utils
node_performance_report -->|"uses series"| node_time_series
node_performance_report -->|"uses metrics"| node_fund_metrics
node_csv_conversion -->|"generates report"| node_performance_report
node_csv_conversion -->|"uses data"| node_market_data
node_csv_conversion -->|"uses dates"| node_date_utils

click node_market_data "https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/data_access.py"
click node_date_utils "https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/qsdateutil.py"
click node_feature_definitions "https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/features.py"
click node_feature_pipeline "https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/featutil.py"
click node_feature_classes "https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/classes.py"
click node_knn "https://github.com/charlesg/pftk/blob/master/pftk/pftklearn/kdtknn.py"
click node_other_learners "https://github.com/charlesg/pftk/tree/master/pftk/pftklearn"
click node_time_series "https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/tsutil.py"
click node_strategies "https://github.com/charlesg/pftk/blob/master/pftk/pftkstrat/strategies.py"
click node_trade_sim "https://github.com/charlesg/pftk/blob/master/pftk/pftksim/tradesim.py"
click node_event_study "https://github.com/charlesg/pftk/tree/master/pftk/pftkstudy"
click node_csv_conversion "https://github.com/charlesg/pftk/blob/master/pftk/pftktools/csv2fund.py"
click node_performance_report "https://github.com/charlesg/pftk/blob/master/pftk/pftktools/report.py"
click node_fund_metrics "https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/fundutil.py"
click node_market_data_tools "https://github.com/charlesg/pftk/tree/master/pftk/pftktools"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_market_data,node_date_utils,node_market_data_tools toneBlue
class node_feature_definitions,node_feature_pipeline,node_feature_classes,node_knn,node_other_learners,node_time_series toneAmber
class node_strategies,node_trade_sim,node_event_study toneMint
class node_csv_conversion,node_performance_report,node_fund_metrics toneRose
class node_external_data toneIndigo
```

## Components

### Market data

- [Market data access](https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/data_access.py): `pftk/pftkutil/data_access.py`
- [Date utilities](https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/qsdateutil.py): `pftk/pftkutil/qsdateutil.py`
- [Market data tools](https://github.com/charlesg/pftk/tree/master/pftk/pftktools): `pftk/pftktools`

### Features and learning

- [Feature calculations](https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/features.py): `pftk/pftkfeat/features.py`
- [Feature preparation](https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/featutil.py): `pftk/pftkfeat/featutil.py`
- [Feature classes](https://github.com/charlesg/pftk/blob/master/pftk/pftkfeat/classes.py): `pftk/pftkfeat/classes.py`
- [KNN learner](https://github.com/charlesg/pftk/blob/master/pftk/pftklearn/kdtknn.py): `pftk/pftklearn/kdtknn.py`
- [Other learners](https://github.com/charlesg/pftk/tree/master/pftk/pftklearn): `pftk/pftklearn`
- [Time-series utilities](https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/tsutil.py): `pftk/pftkutil/tsutil.py`

### Trading and studies

- [Trading strategies](https://github.com/charlesg/pftk/blob/master/pftk/pftkstrat/strategies.py): `pftk/pftkstrat/strategies.py`
- [Trade simulation](https://github.com/charlesg/pftk/blob/master/pftk/pftksim/tradesim.py): `pftk/pftksim/tradesim.py`
- [Event studies](https://github.com/charlesg/pftk/tree/master/pftk/pftkstudy): `pftk/pftkstudy`

### Conversion and reporting

- [CSV fund conversion](https://github.com/charlesg/pftk/blob/master/pftk/pftktools/csv2fund.py): `pftk/pftktools/csv2fund.py`
- [Performance reporting](https://github.com/charlesg/pftk/blob/master/pftk/pftktools/report.py): `pftk/pftktools/report.py`
- [Fund metrics](https://github.com/charlesg/pftk/blob/master/pftk/pftkutil/fundutil.py): `pftk/pftkutil/fundutil.py`

### Other components

- **Market data sources**

## Connections

- Feature preparation → Feature calculations: uses features (evidence: `pftk/pftkfeat/featutil.py`)
- Feature preparation → Feature classes: uses classes (evidence: `pftk/pftkfeat/featutil.py`)
- Feature preparation → KNN learner: trains learner (evidence: `pftk/pftkfeat/featutil.py`)
- Feature preparation → Market data access: uses data (evidence: `pftk/pftkfeat/featutil.py`)
- Feature preparation → Date utilities: uses dates (evidence: `pftk/pftkfeat/featutil.py`)
- Feature preparation → Time-series utilities: uses series (evidence: `pftk/pftkfeat/featutil.py`)
- Market data access → Market data sources: loads market data
- Trade simulation → Time-series utilities: uses series (evidence: `pftk/pftksim/tradesim.py`)
- Performance reporting → Market data access: uses data (evidence: `pftk/pftktools/report.py`)
- Performance reporting → Date utilities: uses dates (evidence: `pftk/pftktools/report.py`)
- Performance reporting → Time-series utilities: uses series (evidence: `pftk/pftktools/report.py`)
- Performance reporting → Fund metrics: uses metrics (evidence: `pftk/pftktools/report.py`)
- CSV fund conversion → Performance reporting: generates report (evidence: `pftk/pftktools/csv2fund.py`)
- CSV fund conversion → Market data access: uses data (evidence: `pftk/pftktools/csv2fund.py`)
- CSV fund conversion → Date utilities: uses dates (evidence: `pftk/pftktools/csv2fund.py`)
