Ticket #5 (closed task: fixed)

Opened 1 year ago

Last modified 9 months ago

SincLib Documentation

Reported by: brian Assigned to: brian
Priority: major Component: SincLib
Keywords: Cc:

Description

A significant amount of documentation is needed for SincLib, both in webpage and TeX form. This ticket is the master for all documentation-related tasks. As children tickets are created for SincLib, they will be referenced on this page.

Documentation Needed

  • Keep webpage and TeX documentation sync'd. The TeX documentation should focus more on the library API and implementation details, while the webpage should focus on installation and usage.
  • Initial usage documents for an ODE, a PDE, and integration.
  • Initial usage documents for the Sinc Method of Lines. Might be useful to describe its setup.
  • Description of solvers available.
  • Optimizations used
  • Parallel methods
  • Writing code with SincLib
  • General walkthrough of directory structure

Change History

04/23/07 09:46:39 changed by anonymous

  • owner changed from brian to anonymous.
  • status changed from new to assigned.
  • component changed from GraphTool to SincLib.

04/23/07 09:51:20 changed by brian

  • owner changed from anonymous to brian.
  • status changed from assigned to new.

Using SincLib documentation is on #6.

04/23/07 21:50:53 changed by brian

Walkthrough was started at the following URL:

http://t2.unl.edu/documentation/sinclib/walkthrough

Directory structure outline has begin; would still like to see comments on the defaults system and logging system, at the least.

04/24/07 11:34:24 changed by brian

For the walkthrough, directory structure outline has been finished. It would be nice to add links to other documentation there.

A couple of paragraphs on the logging system has been included.

04/24/07 12:51:56 changed by brian

Also needed: conformal mappings used.

07/06/07 13:37:23 changed by anonymous

  • cc set to painting.
  • component changed from SincLib to Other.
  • summary changed from SincLib Documentation to painting.
  • priority changed from major to trivial.
  • keywords set to painting.
  • type changed from enhancement to task.

07/06/07 17:17:10 changed by brian

  • status changed from new to assigned.
  • cc deleted.
  • component changed from Other to SincLib.
  • summary changed from painting to SincLib Documentation.
  • priority changed from trivial to major.
  • keywords deleted.

Removed some spam. The rest will have to be taken out from the DB.

01/15/08 23:34:42 changed by brian

  • status changed from assigned to closed.
  • resolution set to fixed.