wiki:MiscNotes

Version 9 (modified by toby, 9 years ago) (diff)

--

Information for Folks Writing Code

GSAS-II routines are copyright protected, but are available for reuse in other non-commercial codes with appropriate scholarly acknowledgment. Contribution of code to the GSAS-II is encouraged. Accounts on this site can be made available to people who become active in development.

GSAS-II Developer's Documentation

A pdf (https://subversion.xor.aps.anl.gov/pyGSAS/sphinxdocs/build/latex/GSASIIdoc.pdf) (>150 pages) or html (https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/html/index.html) manual for the routines in GSAS-II has been prepared with Sphinx. This lists and indexes all top-level routines and classes and documents many of them.

Reusable Modules

These modules have been better documented than most and are intended for standalone as well as internal use:

GSAS-II Unit Tests

The hope is that all sections of GSAS-II code will have unit tests, following the outline defined here.

GSAS-II Project tracking

Updates to the source code can be followed using the Timeline Trac tool at this website. The Tickets and Roadmap features are not currently in use.

misc:

To make web pages on this site display properly, be sure to set their properties:

  • svn propset svn:mime-type text/html *.htm*
  • svn propset svn:mime-type application/octet-stream *.gif *.png
  • svn propset svn:mime-type text/css *.css
  • svn propset svn:mime-type text/javascript *.js
  • svn propset svn:mime-type application/pdf *.pdf