Skip to content

Add initial software paper scaffold #29

Description

@dcajal

Goal

Add the initial software paper scaffold for a future JOSS, SoftwareX, or similar software-publication submission.

Proposed location

paper/
  paper.md
  paper.bib

Paper framing

The paper should frame Biosiglib/Biosigmat/Biosigpy as a reproducible multi-language biomedical signal-processing software ecosystem, not as a single MATLAB toolbox.

Core claim:

Biosiglib defines language-independent, machine-readable algorithm specifications and conformance cases; Biosigmat and Biosigpy are independent implementations that validate against the same release-pinned specification source.

Required sections

Initial paper.md should include at least:

  • Title.
  • Summary.
  • Statement of need.
  • Software architecture.
  • Reproducibility and conformance model.
  • Pilot specifications:
    • hrv.tdmetrics
    • ecg.pantompkins
  • Relationship to existing software and scientific references.
  • Availability.
  • Acknowledgements.
  • References.
  • AI usage disclosure placeholder if targeting JOSS.

Important constraints

  • Do not overclaim clinical validation.
  • Do not imply Biosiglib replaces citations to the original scientific algorithm publications.
  • Do not claim broad API completeness yet.
  • State clearly that the current public MVP demonstrates the architecture through two pilot specifications.
  • Keep journal venue neutral for now unless a target is explicitly chosen.

Validation

  • If Pandoc or JOSS tooling is available locally, run it.
  • Otherwise, check Markdown structure and references manually.
  • Run existing Biosiglib validation:
    • python tools/validate_specs.py
    • python -m compileall tools
  • Run git diff --check.

Notes

This issue should not submit the paper anywhere and should not create a DOI. It only adds the internal paper scaffold.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions