Skip to content

[JOSS] Write paper.md manuscript #101

@KedoKudo

Description

@KedoKudo

Summary

Write the JOSS paper manuscript following the journal's format requirements.

JOSS Paper Requirements

The paper should be short (typically 1-2 pages, ~1000 words max) and include:

Required Sections

  • Title: Clear, descriptive title
  • Authors: List with ORCID identifiers and affiliations
  • Summary: Brief description of the software (2-3 paragraphs)
  • Statement of Need: Why this software exists, target audience, research context
  • Features: Key functionality (not exhaustive)
  • Comparison: How it relates to other software in the field
  • Acknowledgements: Funding, contributions
  • References: Citations to relevant papers

Content Guidelines

Focus on:

  • High-performance TPX3 processing (96M+ hits/sec)
  • Multiple clustering algorithms (ABS, DBSCAN, Grid)
  • Python bindings via PyO3
  • GUI for interactive analysis
  • NeXus-compatible HDF5 output

File Structure

paper/
├── paper.md      # Main manuscript (Markdown)
├── paper.bib     # References (BibTeX)
└── figures/
    └── architecture.png  # Optional figures

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions