1 / 1

Nemo5 automatic documentation

Nemo5 automatic documentation. Objective: to create interactive documentation system of Nemo5 entities Access available options of an entity Validate options on an inputdeck Generate an updated manual automatically. Approach:

deidra
Download Presentation

Nemo5 automatic documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Nemo5 automatic documentation • Objective:to create interactive documentation system of Nemo5 entities • Access available options of an entity • Validate options on an inputdeck • Generate an updated manual automatically Approach: [1] to develop an interface between developers and nemo5 entities options. [2] to define a API to access information about available option and properties. [3] to validate the correctness of and inputdeck on runtime. • Results: • “./nemo --help #Solver” lists all available options for a specified solver, it shows a default value if it is not required and a description. • “./nemo--list-solves” lists all available solvers. • “./nemo--manual”, generate an updated manual including all solvers and options registered [not available yet]. Daniel Mejia, Gerhard Klimeck

More Related