Skip to content

Language pages for catch22 v1.0 - #7

Merged
benfulcher merged 3 commits into
mainfrom
docs/v1.0-language-pages
Oct 20, 2026
Merged

benfulcher merged 3 commits into
mainfrom
docs/v1.0-language-pages

Conversation

@benfulcher

Copy link
Copy Markdown
Contributor

Updates the language pages, API references, citing page and home page for catch22 v1.0 (the feature descriptions were #6).

Merge after pycatch22 1.0.0 is on PyPI, because the Python pages document the 1.0 API (DynamicsAndNeuralSystems/pycatch22#43).

  • C: build with gcc -O2 C/*.c -o run_features -lm; the --catch22/--catch24, --no-mask and --list flags; masking (using testShort.txt, where rs_range and dfa are masked); runAllTS.sh; and a new section on calling catch22_compute() from your own C code. Example outputs are real outputs from v1.0.1.
  • MATLAB: mexAll builds the single catch22_mex; catch22_all(x, doCatch24, maskNaNs) returns values, long names, short names and isMasked, with both flags defaulting to true; GetAllFeatureNames has four outputs. The per-feature catch22_<name> functions no longer exist, so that section now selects from catch22_all by name. Not run (based on the source), so no MATLAB output is shown.
  • Python: pycatch22 1.0 (masking, return_masked, feature_table(), per-feature functions, deprecated v0.x aliases, new feature order). Multithreading now uses ThreadPoolExecutor, since the GIL is released (3.8x faster with 4 threads). All outputs were produced with pycatch22 1.0.
  • Citing: how to cite a software version through Zenodo (v1.0.1 and v1.0.0 DOIs, and the concept DOI).
  • Home: a short v1.0 note linking to the feature descriptions.
  • R and Julia: only a warning that the packages don't yet implement v1.0. Those pages get updated when Rcatch22 and Catch22.jl reach 1.0.

Left as they were: the sktime FAQ in the Python page, and the home page's link to the hctsa commit catch22 was originally selected from.

🤖 Generated with Claude Code

benfulcher and others added 3 commits October 20, 2026 11:34
- C: build with `gcc -O2 C/*.c -o run_features -lm`; --catch22/--catch24,
  --no-mask and --list flags; v1.0 example output; masking; runAllTS.sh
  options; calling catch22_compute from your own C code.
- MATLAB: single catch22_mex built by mexAll; catch22_all(data, doCatch24,
  maskNaNs) with its isMasked output; GetAllFeatureNames' legacy names and
  hctsa calls; testing.m; per-feature functions no longer exist.
- Python: pycatch22 1.0 API (mask_nans, return_masked, feature_table,
  per-feature functions with deprecated v0.x aliases); threads now run in
  parallel (the GIL is released); feature order changed, so index by name.

All example outputs are from catch22 v1.0.1 / pycatch22 1.0.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Home: v1.0 matches hctsa v3.0.0 and changes values relative to v0.x.
- Citing: cite the software version via Zenodo (version DOIs for v1.0.0
  and v1.0.1, and the concept DOI for all versions).
- R and Julia pages (and their API pages): Rcatch22 and Catch22.jl do not
  yet implement catch22 v1.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… (C)

pycatch22 1.0's per-feature functions now compute only their feature (via
catch22 v1.1.0's catch22_compute_feature), so drop the advice that they
compute everything. Document pycatch22.compute_feature(data, name) and, on
the C page, catch22_compute_feature and catch22_feature_index. Add the v1.1.0
DOI to the citing page. Examples checked against pycatch22 1.0 and catch22
v1.1.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@benfulcher
benfulcher marked this pull request as ready for review October 20, 2026 00:49
@benfulcher
benfulcher merged commit 595f212 into main Oct 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant