Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare JOSS manuscript #8

Open
2 of 16 tasks
bobleesj opened this issue Jul 5, 2024 · 1 comment
Open
2 of 16 tasks

Prepare JOSS manuscript #8

bobleesj opened this issue Jul 5, 2024 · 1 comment
Assignees
@bobleesj
Labels
documentation Improvements or additions to documentation

Comments

@bobleesj
Copy link
Owner

bobleesj commented Jul 5, 2024 •
edited
Loading

JOSS requirements from the website:

  • 250 to 1,000 words
  • The software must have an obvious research application
  • Not less than three months of work for an individual.
  • Whether the software has already been cited in academic papers.
  • Your paper must not focus on new research results accomplished with the software.
  • Whether the software is sufficiently useful that it is likely to be cited by your peer group.
  • Your paper (paper.md and BibTeX files, plus any figures) must be hosted in a Git-based repository together with your software.
  • Include in the paper some sentences that explain the software functionality and domain of use to a non-specialist reader.

Specifics to cifkit:

  • Add architecture diagram of the software
  • Add histograms, add polyhedron images
  • Discuss 4 coordination geometry methods
  • Discuss atomic mixing categorization
  • Discuss preprocessing step
  • Discuss performance vs. supercell size
  • Discuss unique values & problems addressed
  • Feature software that currently uses cifkit

Reference:

TBA
@bobleesj bobleesj self-assigned this Jul 5, 2024
@bobleesj
Copy link
Owner Author

bobleesj commented Jul 5, 2024

Potential name for the paper:

  • cifkit: Python package for CIF high-throughput analysis

@bobleesj bobleesj added the documentation Improvements or additions to documentation label Jul 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bobleesj bobleesj

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bobleesj