Community Guidelines

1. What we accept

IDCube Community currently welcomes Python-based algorithms, scripts, and workflows relevant to hyperspectral imaging and spectral data analysis, including image processing, spectral analysis, machine learning, remote sensing, biological imaging, and visualization.

• Submissions may run in the IDCubePro 2026 Python Workspace, as standalone Python, or both.
• MATLAB, R, and other-language code are not accepted in this initial release.
• Contributions may be experimental or research-oriented, but must be clearly described as such.

2. Submission checklist

To help others reproduce your work, provide:

• Algorithm title, author name, contact email, and a brief plain-language description.
• A public GitHub link or the Python source files in a supported upload format.
• A README with setup steps, example usage, expected inputs/outputs, and any relevant citations.
• Python version, required packages, and hardware or operating-system limitations, if applicable.
• A clear software license and the compatibility category you are claiming.
• Example data or output images where practical, using only data you are authorized to share.

3. Ownership, attribution & licensing

• You retain ownership of code you contribute. Submission does not transfer copyright to HSpeQ.
• You must own the contribution or have permission to distribute the code, dependencies, documentation, and included data.
• Every published contribution must identify a license that permits its intended distribution. MIT, BSD-3-Clause, and Apache-2.0 are examples, but authors may choose another compatible license.
• Provide proper attribution to collaborators, libraries, datasets, and scientific publications.
• By submitting, you give HSpeQ permission to review and, if accepted, display your submitted description and redistribute or link to the submitted materials under the stated license, with attribution.

Do not submit code or data that violates a third party's intellectual property rights or usage terms.

4. Security, privacy & reproducibility

• Do not include passwords, API keys, access tokens, private patient information, identifiable research participant data, or other confidential content.
• Disclose network access, downloads, installation steps, and any external services your scripts require.
• Do not submit malicious code, hidden data collection, cryptocurrency mining, or destructive operations.
• Disclose known limitations, numerical assumptions, and whether the method has been validated.
• Downloaders should inspect source code and dependencies and run unfamiliar scripts in an appropriately isolated environment before using them with important data.

5. Review & publication

There is no account registration and no automatic publication. Every submission is reviewed by the IDCube Community administrators before it appears in the public library.

• Administrators check completeness, relevance, distribution rights, and apparent technical or security concerns.
• Authors may be contacted for clarifications or corrections.
• Submissions can be accepted, deferred, declined, or removed at the administrators' discretion.
• Reviews may include limited functionality testing, but are not a full security audit or scientific peer review.

6. Compatibility labels

Every listing should clearly state its intended environment:

Compatibility claimed by a contributor is distinct from an HSpeQ Verified designation. That designation is reserved for a specific version tested by HSpeQ in the stated environment, and does not guarantee error-free behavior on all systems.

7. Community conduct & feedback

Contributions and feedback should be professional, constructive, and respectful. Focus on reproducible methods and technical evidence. Do not misrepresent results, authorship, or HSpeQ endorsement. For now, feedback and correction requests can be sent through the submission page or the contact method published with a listing, when available.

8. Updates, corrections & removal requests

Authors can request changes or new releases by contacting the community administrator and referencing their existing listing. Updated packages should have a version number and a summary of changes. HSpeQ may correct metadata, disable links, or remove materials when necessary for legal, security, or community-quality reasons.

To report a suspected rights issue, exposed credential, or harmful submission, contact HSpeQ using the website's published contact channel and identify the affected listing.