Archive HomeSearch CodeBrowse CodeSubmissionLinksAbout

Paleobiology Source Code Archive
Information for contributors and users


General:

  1. The source code and software here is here to be distributed, by posting it you give consent to its distribution.
  2. Use it, play with it, modify it, but don't blame the authors.
  3. Everyone and anyone is welcome to contribute or use the source code or software posted here.
  4. Please send the source code, a compiled version, and a description to post.
    E-mail files to: M. Kosnik (please compress files before you send them).
  5. The code description will then be posted on the web page and the files will placed in the download directory.

What to include when posting:

  1. Include your name / e-mail address in comments at the top of the file.
  2. Include the date of posting.
  3. Include a brief description of what the code does.
  4. Include a brief description of any variables getting past to or from a function.
  5. Include a brief description of any input or output files (special reference to format).
  6. If at all possible please make extensive use of comments in your code.
  7. ANSI C assumed, please add comments if you use some another standard or language.
  8. It would be great if you mention what system/compiler you used.
  9. Include comments outlining any known problems or limitations.
  10. Only post code that is public domain, please refrain from posting any code you have not written.
  11. Keep in mind that this will be most useful for people if everyone tried to make their code as readable as possible.
  12. Include copyright and license information should you choose to do so.
  13. Feel free to send any documentation files or manuals.

Licenses:

I suggest that you legally insure the open nature of your source code and software by using one of the following standard licenses. The Mozilla FAQ contrasts them in non-legal terms.
Check out these sites for the philosophy behind open source and free software.
  1. The GNU General Public license: This is the license that the linux operating system is distributed under. The Free Software Foundation has details on how this license works and how to apply it. This seems to be the best option.
  2. The Artistic license:
  3. The MIT license:

Conventions:

Keep in mind that others will be using your code. So try and make your code as easy to read and use as possible. This might include:
  1. Indent code within brackets (\t).
  2. Use function prototypes, header files a plus.
  3. One command per line.
  4. Identify variables used /*Comments are wonderful*/.
  5. Citations for any formulas used.
  6. Cite papers that describe the methods you implement.
  7. Dynamic memory would be best, but if you use static memory please use constants so that it can be scaled with minimal problems.

File formats:

  1. Text files are saved and downloaded as such. They retain the line breaks from the author's operating system.
  2. Macintosh programs should be compressed in self-extracting archives (.sea) and binhexed (.hqx) for maximum compatibility.
  3. Formats for Windows programs have not become an issue yet, but a standard sort of self-extracting archive would be great.

Valid HTML 4.01!Valid CSS!Site version: 0.8 (2003.02.26) by M. Kosnik