tda-experiment

Scaffolds new topological data analysis experiment modules with tests in domain packages.

1|Updated Dec 13, 2025
One-click install
npx skills add https://github.com/ZK-Theory/TDL --skill tda-experiment-zk-theory
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tda-experiment
Source: https://github.com/ZK-Theory/TDL/tree/main/.github/skills/tda-experiment
Command: npx skills add https://github.com/ZK-Theory/TDL --skill tda-experiment-zk-theory

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Starting a new topological data analysis experiment requires knowing the correct domain package layout, coding conventions, and test structure, which is error-prone when done manually. ## Core Features & Use Cases - Domain-aware scaffolding: Places new experiment files in the correct package for financial_tda, trajectory_tda, or poverty_tda based on the research domain. - Convention enforcement: Generates modules with typed configuration, Google-style docstrings, pathlib paths, logging, and a standard load/compute/analyse/main pipeline structure. - Test stub generation: Creates a matching pytest file with smoke tests and appropriate slow or integration markers. - Use Case: A researcher wants to test a hypothesis about sector crises using Rips filtration on financial data; the Skill asks for the domain, method, and research question, then produces a ready-to-fill experiment module and test file. ## Quick Start Ask the assistant to scaffold a new TDA experiment named sector_crisis_2024 in the financial_tda domain using the Rips method.

Frequently Asked Questions about tda-experiment

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new TDA experiment in this repository?

Invoke the Skill and provide the domain (financial_tda, poverty_tda, or trajectory_tda), a snake_case experiment name, the topological method, and your research question. It creates the experiment module in the correct package plus a test stub.

Where are new TDA experiment files placed?

Financial experiments go in financial_tda/experiments/, trajectory scripts in trajectory_tda/scripts/, and poverty analysis in poverty_tda/analysis/. Test stubs are created in tests/<domain>/test_<name>.py.

What coding conventions do generated experiment modules follow?

Generated modules use Google-style docstrings, type hints, pathlib.Path for file paths, logging instead of print, and a load_data/compute_topology/analyse/main pipeline. Tunable parameters are exposed as function arguments with defaults like n_permutations=1000.

Does the generated experiment include tests?

Yes, a pytest stub is created in tests/<domain>/ with at least one smoke test. It adds @pytest.mark.slow or @pytest.mark.integration markers when the experiment is slow or data-dependent.

Which topological methods can the scaffolded experiments use?

The Skill supports experiments using Rips, Alpha, Mapper, Morse-Smale, and other topological methods. The chosen method is recorded in the module docstring along with the research question and expected output.