Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Add SlicerSOFA Extension #2059

Merged
merged 4 commits into from
Dec 12, 2024
Merged

ENH: Add SlicerSOFA Extension #2059

merged 4 commits into from
Dec 12, 2024

Conversation

RafaelPalomar
Copy link
Contributor

@RafaelPalomar RafaelPalomar commented Jun 17, 2024

New extension

  • Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
  • Repository name is Slicer+ExtensionName
  • Repository is associated with 3d-slicer-extension GitHub topic so that it is listed here. To edit topics, click the settings icon in the right side of "About" section header and enter 3d-slicer-extension in "Topics" and click "Save changes". To learn more about topics, read https://help.github.com/en/articles/about-topics
  • Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
  • Any known related patents must be mentioned in the extension description.
  • LICENSE.txt is present in the repository root. MIT (https://choosealicense.com/licenses/mit/) or Apache (https://choosealicense.com/licenses/apache-2.0/) license is recommended. If source code license is more restrictive for users than MIT, BSD, Apache, or 3D Slicer license then the name of the used license must be mentioned in the extension description.
  • Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (main, release, ...) instead of a specific git hash to avoid re-submitting pull request whenever the extension is updated
  • Extension icon URL is correct (do not use the icon's webpage but the raw data download URL that you get from the download button - it should look something like this: https://raw.githubusercontent.com/user/repo/main/SomeIcon.png)
  • Screenshot URLs (screenshoturls) are correct, contains at least one
  • Homepage URL points to valid webpage containing the following:
    • Extension name
    • Short description: 1-2 sentences, which summarizes what the extension is usable for
    • At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
    • Description of contained modules: at one sentence for each module
    • Tutorial: step-by-step description of at least the most typical use case, include a few screenshots, provide download links to sample input data set
    • Publication: link to publication and/or to PubMed reference (if available)
    • License: We suggest you use a permissive license that includes patent and contribution clauses. This will help protect developers and ensure the code remains freely available. We suggest you use the Slicer License or the Apache 2.0. Always mention in your README file the license you have chosen. If you choose a different license, explain why to the extension maintainers. Depending on the license we may not be able to host your work. Read here to learn more about licenses.
    • [X ] Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
  • Hide unused features in the repository to reduce noise/irrelevant information:
    • Click Settings and in repository settings uncheck Wiki, Projects, and Discussions (if they are currently not used)
    • Click the settings icon next to About in the top-right corner of the repository main page and uncheck Releases and Packages (if they are currently not used)

RafaelPalomar referenced this pull request in NA-MIC/ProjectWeek Jun 22, 2024
@jcfr jcfr changed the title ENH: Add SlicerSofa Extension ENH: Add Slicer-SOFA Extension Jun 27, 2024
@lassoan
Copy link
Contributor

lassoan commented Jun 27, 2024

Could we use SlicerSOFA instead of Slicer-SOFA in both the github repository name and json file?
It is quite annoying that 1-2 extensions uses dash in the name, and I always have to remember when searching for the extension.

@jcfr
Copy link
Member

jcfr commented Jun 27, 2024

Could we use SlicerSOFA instead of Slicer-SOFA in both the github repository name and json file?

Agreed. I will let @RafaelPalomar rename the GitHub project

@jcfr jcfr changed the title ENH: Add Slicer-SOFA Extension ENH: Add SlicerSOFA Extension Jun 27, 2024
@lassoan
Copy link
Contributor

lassoan commented Nov 16, 2024

This does not build on Windows due to boost. (adding address-model=64 architecture=x86 arguments to b2 helps a bit, but boost install still fails)

@lassoan lassoan added the Status: Awaiting Response ⏳ Waiting for a response/more information label Nov 16, 2024
@RafaelPalomar
Copy link
Contributor Author

This does not build on Windows due to boost. (adding address-model=64 architecture=x86 arguments to b2 helps a bit, but boost install still fails)

@lassoan SOFA does not need to build/install Boost; it uses header-only components. In Slicer/SlicerSOFA#28 we made changes in the build system, so boost is not built nor installed. I have not tried yet on Windows, but this should solve these problems.

@lassoan
Copy link
Contributor

lassoan commented Dec 11, 2024

@RafaelPalomar confirmed that the extensions build and packaging now works well on Windows with Slicer/SlicerSOFA#28. If you merge that PR then we can merge this.

Copy link
Contributor

@lassoan lassoan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks good, thanks a lot @RafaelPalomar

@lassoan lassoan merged commit 24cd903 into Slicer:main Dec 12, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting Response ⏳ Waiting for a response/more information
Development

Successfully merging this pull request may close these issues.

3 participants