- The file name should be
Spec_CamelCase.md
in the Specifications directory. - Please use the markdown format.
- Because GitHub started to support math description (link), we need to describe equations suit with the rule of GitHub and MathJax.
- Write an overview of features to be realized using the class or library here clearly.
- Enumerate all related codes and input files here
- Write how to use the class or functions
Write important algorithms for the class, the library, or each function. Please use equations, figures, reference papers for easy understanding.
- Please summarize the
- Please list up inputs and outputs
- Please use math description when you need as follows
$$\dot{\boldsymbol{x}}=f(\boldsymbol{x},t)$$
- you can also use inline equation as
$x=y$
- please write a reason why the author does the verification
- input files
- initial values
- please use figures to show the results clearly
- Upload the figure files in
figs
directory- Note: the figure size should be smaller than several hundred K Bytes
- Smaller is better
- Link the figure file with relative path
- Note: the figure size should be smaller than several hundred K Bytes