Skip to content

Documentation enhancement #30

@Zach-Clare

Description

@Zach-Clare

Include the following in documentation:

  • Input grid needs to be Re
  • Input grid needs to be uniform
  • Input grid needs to conform to x standard (BATSRUS). Include labelled example?
  • Better detail on what the output FITS file contains. Which data extensions, what units, headers?
  • Tell the user that the given position input needs to be inside the grid
  • Currently the flags section only describe how to use CMEM. Tell them about -i, -t!

Basically, this software is a bit hard to use unless you work with me, so we want this documentation to be really really good so that anyone can use it with just the README.md.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions