Difference between revisions of "Documentation/4.0/SlicerApplication/ExtensionCatalogPolicies"
From Slicer Wiki
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887) |
|||
| (58 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
| + | __NOTOC__ | ||
| + | This is work in progress as of March 2012 - people with an interest in policies and practice related to this topic should contact Ron Kikinis. | ||
| + | |||
=Introduction= | =Introduction= | ||
| − | + | Slicer functionality is extensible through ''Extensions'' which can be added to the package. The slicer community maintains a website to support the finding, download and installing Extensions for 3D Slicer 4. Access to this website is integral to Slicer 4 and facilitated by the Extensions Manager functionality built into the distributed program. Please see [[Documentation/{{documentation/version}}/Developers/Tutorials/ExtensionWriting|here]] for information for software developers on how to add your extension to this website. The following text details the policies for Slicer Extensions. | |
| − | 4. | + | |
| − | + | =Slicer Extensions Catalog= | |
| − | + | ||
| − | + | The download site is referred to as the '''Slicer Extensions Catalog'''. The Catalog classifies extensions into three levels of compliance: | |
| + | *Category 1: Fully compliant Slicer Extensions: Slicer license, open source, maintained. | ||
| + | *Category 2: open source, contact exists. | ||
| + | *Category 3: all other extensions (work in progress, beta, closed source etc). | ||
| + | |||
| + | The initial presentation when visiting the page will present fully compliant (Cat 1) extensions. Search will allow to search all extensions. The toplevel interface will have a link for developers to the pages describing the requirements. | ||
| + | |||
| + | =Requirements for Category 1 Slicer Extensions= | ||
| + | |||
| + | Category 1 extensions must meet the following conditions: | ||
| + | *comply with the [http://www.slicer.org/pages/LicenseText Slicer License] | ||
| + | *compile and install on all platforms supported by slicer | ||
| + | *have test coverage of better than 60% | ||
| + | *have documentation at a level of quality comparable to slicer core modules | ||
| + | *have a designated person to answer emails in relation to the extension which are posted on the two slicer mailing lists. | ||
| + | *are updated to support new versions of the OS, new versions of packages (such as VTK, ITK), etc. | ||
| + | |||
| + | =Requirements for Category 2 Slicer Extensions= | ||
| + | Category 2 extensions must meet the following conditions: | ||
| + | *be avalable under a compatible open source license | ||
| + | *have a designated maintainer to respond to questions about the extension | ||
| + | *have a clear declaration about the license under which the code is distributed | ||
| − | + | =Category 3 Slicer Extensions= | |
| − | + | Category 3 Slicer Extensions cover everything else, including developers who do not want to share their source code or extensions. | |
| − | + | *I do not want to share my source code: When source code is not shared, it is not possible to inspect the code for malicious content. This is a potential security risk that we will not accept for the Slicer website. | |
| − | + | *Developers are free to set up their own Midas servers for hosting extensions if they want to host category 3 extensions, or can just make .tar.gz files and set the module path in Slicer manually. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | *Slicer | ||
| − | * | ||
| − | |||
Latest revision as of 07:30, 14 June 2013
Home < Documentation < 4.0 < SlicerApplication < ExtensionCatalogPolicies
|
For the latest Slicer documentation, visit the read-the-docs. |
This is work in progress as of March 2012 - people with an interest in policies and practice related to this topic should contact Ron Kikinis.
Introduction
Slicer functionality is extensible through Extensions which can be added to the package. The slicer community maintains a website to support the finding, download and installing Extensions for 3D Slicer 4. Access to this website is integral to Slicer 4 and facilitated by the Extensions Manager functionality built into the distributed program. Please see here for information for software developers on how to add your extension to this website. The following text details the policies for Slicer Extensions.
Slicer Extensions Catalog
The download site is referred to as the Slicer Extensions Catalog. The Catalog classifies extensions into three levels of compliance:
- Category 1: Fully compliant Slicer Extensions: Slicer license, open source, maintained.
- Category 2: open source, contact exists.
- Category 3: all other extensions (work in progress, beta, closed source etc).
The initial presentation when visiting the page will present fully compliant (Cat 1) extensions. Search will allow to search all extensions. The toplevel interface will have a link for developers to the pages describing the requirements.
Requirements for Category 1 Slicer Extensions
Category 1 extensions must meet the following conditions:
- comply with the Slicer License
- compile and install on all platforms supported by slicer
- have test coverage of better than 60%
- have documentation at a level of quality comparable to slicer core modules
- have a designated person to answer emails in relation to the extension which are posted on the two slicer mailing lists.
- are updated to support new versions of the OS, new versions of packages (such as VTK, ITK), etc.
Requirements for Category 2 Slicer Extensions
Category 2 extensions must meet the following conditions:
- be avalable under a compatible open source license
- have a designated maintainer to respond to questions about the extension
- have a clear declaration about the license under which the code is distributed
Category 3 Slicer Extensions
Category 3 Slicer Extensions cover everything else, including developers who do not want to share their source code or extensions.
- I do not want to share my source code: When source code is not shared, it is not possible to inspect the code for malicious content. This is a potential security risk that we will not accept for the Slicer website.
- Developers are free to set up their own Midas servers for hosting extensions if they want to host category 3 extensions, or can just make .tar.gz files and set the module path in Slicer manually.
