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

Complete documentation of new package #103

Open
2 of 7 tasks
axch opened this issue Apr 19, 2017 · 0 comments
Open
2 of 7 tasks

Complete documentation of new package #103

axch opened this issue Apr 19, 2017 · 0 comments
Labels
usability

Comments

@axch
Copy link
Collaborator

axch commented Apr 19, 2017 •
edited by edoddridge
Loading

We should document the following topics

  • Usage and options for the command line executable, once that exists (Incrementally complete the packaging plan #102).
  • Format of the configuration file, including named input generators
  • User API for custom input generators
  • Developer API for how to add more named input generators
  • Workflow for reading the generated output (core.interpret_raw_file, non-portability thereof across systems, etc).
  • Describe each parameter, including units (Document the meaning and units of measurement of all the parameters. #58), in
    • The online help of the executable (once that exists)
    • The generated documentation of the top level Python function
    • Comments in the example aronnax.conf file
  • Ideally, arrange the mechanism for that description to minimize duplication of words across these presentation channels (so they stay in sync).
@axch axch added the usability label Apr 19, 2017
@axch axch mentioned this issue Apr 19, 2017
Merged
edoddridge added a commit that referenced this issue May 3, 2017
@edoddridge
Add example config file and docs, remove old one
bb53220 
A version of the new aronnax.conf file has been added to the base directory of the repo. This config file includes all of the paramters and inputs that can be specified as well as comments describing them. This partially completes #103. The documenation page `running_aronnax` ingests this config file and displays it, along with its comments and some additional descriptive text.
@edoddridge edoddridge mentioned this issue May 3, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
usability
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@axch