Skip to content
This repository has been archived by the owner on Dec 31, 2021. It is now read-only.

Submission types

Jump to bottom
Kevin Dunn edited this page May 9, 2011 · 4 revisions

There are 3 types of submissions to the site:

  1. Cookbook snippets and scripts: code examples and snippets showing how to do something very specific. E.g. draw an ellipse, calculate the eigenvalue decomposition of a complex matrix, a Sudoku puzzle creator, or simulate a chatic system of differential equations with plots.

    They can be a couple of lines, but the main point is that the submission is a is single, standalone file. It may contain one or more functions.

    These submissions can be chosen to be public domain (CC0) or BSD licensed. They can be improved by the original user, or modified into a new submission (with attribution back) by other registered users.

  2. Complete packages: a collection of files that solve a complete problem. E.g. a "wavelet toolbox" with a group of files and perhaps a GUI interface in PyQt that allows interactive signal processing using various wavelets.

    This submission is a series of files, and other perhaps other media, such as data files to get the user started. We hope that users will also submit documentation with these submissions in the form of a README.rst file.

    The submissions are chosen to be public domain (CC0) or BSD licensed. Other licenses are not under consideration. See the discussion around 30 to 31 October 2010 on the Scipy mailing list for reasons why.

    Since the code package and its documentation is a serious piece of work, this site provides an authoritative place for it. Only the original submitter can update this work. Other users may create derived versions, but should consider submitting change requests to the original submitter first.

  3. References: are of 3 types (though we don't distinguish these in the backend database)

    • Other scientific software: for example, linking to PyPi, GitHub, Google Code, or a private home page elsewhere.
    • Publications: We also encourage links to journal publications, or other scholarly work that uses scientific programming tools in Python.
    • Documentation: links to the official SciPy and NumPy documentation, that already includes the code snippet. No need to reproduce that in SciPy Central.

    The common denominator of these 3 types is a title, URL and description.

    These entries are for people searching for existing packages and code, so that users can find them, but the original code developer need not submit them here. We rely on the submitter's description and tagging to make searching useful for end users.

    We will try to automatically populate this part of the website in the future..

Clone this wiki locally