MAP Background Information

Contents

1. Your commitment.

2. Our commitment.

3. Guidelines for code providers.

3.1 Data transfer.

3.2 Documentation.

1. Your commitment.

Yours | Ours | Guidelines | Contact info. | Links | MAP homepage

Before code can be accepted for distribution on the MAP website, the supplier MUST agree that, to the best of his/her knowledge :-

• Code is original work.
• Contributions by others clearly acknowledged as such.
• Code contains no commercially-available code (including shareware or freeware) or direct references to such.
• The supplier is free to supply the code to others.
• Code is free from considerations of academic, commercial or military secrecy, or any other restrictions on dissemination.
• Accompanying documentation is complete and accurate, and including sample data and results if appropriate (see below).

You must enclose a signed copy of the Code Donor Agreement.

2. Our commitment.

| Yours | Ours | Guidelines | Contact info. | Links | MAP homepage

• All suppliers will be clearly acknowledged in accompanying documentation
• Code will be supplied without cost to the originator.
• Code downloaded from the MAP website may be modified and distributed without restriction PROVIDED that :-
  • MAP and the code originator are acknowledged in the documentation and in the body of the source code
  • Any modifications are clearly indicated as such
  • No attempt is made to charge for subsequent distribution of the code.

3. Guidelines for code suppliers.

| Yours | Ours | Guidelines | Contact info. | Links | MAP homepage

3.2 Documentation

3.2.1. Source code

Source code should be provided as ASCII text files only, though accompanying hard copy is welcome.

3.2.2. Accompanying documentation.

Documentation supplied with source code should include :-

1. Brief statment of purpose of code and description of operating principles.
2. A list of input and output arguments, including type, eg double precision, integer, etc, and purpose.
3. References for theoretical basis of code (where appropriate).
4. Statement of known accuracy limits, or input conditions likely to result in an error.
5. A list of keywords (for benefit of search engine).
6. A sample program demonstrating the use of the routine, including sample input data and results.
7. Notification of use of code in published documents, eg conference papers, refereed journals, etc. (These may be same as [3]).

Links

| Yours | Ours | Guidelines | Contact info. | Links | MAP homepage

Return to top of document