Skip to content

Add citation metadata and link the published JSIAM Letters paper #127

Description

@t-uda

Goal

Add repository-level citation metadata for EllPHi and link the now-published JSIAM Letters paper.

Background

The relevant paper appears to be:

Tasks

  • Add a root-level CITATION.cff / citation.cff file, following the current Citation File Format schema.
  • Include software-level metadata for EllPHi:
    • title/name of the software,
    • repository URL,
    • authors/maintainers,
    • licence if available,
    • release/version metadata if already defined in the repo.
  • Add the JSIAM Letters paper as the preferred-citation or otherwise clearly reference it from the CFF file.
  • Add or update README/documentation citation instructions so users know how to cite both:
    • the software repository/package, and
    • the published JSIAM Letters paper.
  • Ensure the DOI and J-STAGE link are correct before merging.

Acceptance criteria

  • GitHub displays citation metadata from the CFF file.
  • README or equivalent documentation includes a concise citation section.
  • The published paper link and DOI are included and not merely mentioned as forthcoming/preprint.
  • Existing package metadata is not contradicted by the new citation metadata.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions