search

scenerygraphics / sciview

sciview is a tool for visualization and interaction with ND image and mesh data
BSD 2-Clause "Simplified" License
67 stars 17 forks source link

Migrate examples into separate repo #372

Closed kephale closed 3 months ago

kephale commented 3 years ago

@frauzufall and I discussed migrating the examples out of the main sciview repo into their own. This comes with an additional suggestion that we would actually have 2 repos of examples: 1 for Java implementations, and 1 for Kotlin implementations.

This would require some changes to scripts in https://github.com/scenerygraphics/sciview-update-sites (and the corresponding scripts for releasing to the SciView-Unstable update site in the main sciview repo), where we would need to add the sciview-examples-kotlin repository to the update site.

bump to @elect86 and @skalarproduktraum for discussion.

skalarproduktraum commented 3 years ago

Would you still ship them together with sciview?

kephale commented 3 years ago

Definitely. We are going to need to eventually revamp the SciView-Unstable deployment, but as is the stable update site is setup on https://github.com/scenerygraphics/sciview-update-sites, which can easily add in a supplemental examples package (presumably from the proposed sciview-examples-kotlin repo)

kephale commented 1 year ago

@skalarproduktraum @ctrueden I'm revisiting this discussion after some time. This doesn't sound like a good use of our time right now, or even before 1.0.0.

elect86 commented 1 year ago

What were the reasons in the first place?

kephale commented 1 year ago

I believe we wanted to make it easier for folks to work with smaller/simpler projects that changed less. Also to make it possible for a Java/Maven dev to have a project without needing to adjust to the gradle/Kotlin part of the codebase. That has been a pretty regular request from the community in the past.

This is something we can pretty easily do in the future, and I don't see a clear benefit at this point in time.

ctrueden commented 1 year ago

I like the simplicity of keeping the examples here in the same repository, as long as it doesn't bloat the repo size by many MB.

Tangentially: right now the repo is 135M, but only because @PowerOfNames's simvis branch bloats the repository hugely by committing many files to a models directory. That branch should never be merged as is, but rather reworked to never add large binaries in the first place.

Dumb question though: which files in this repo currently constitute "examples"? I couldn't figure it out.

elect86 commented 1 year ago

We may rework the sample, hosting the files somewhere and introducing a layer that has to be queried for the models, to be downloaded in some temp folder as soon as they are requested

kephale commented 1 year ago

Dumb question though: which files in this repo currently constitute "examples"? I couldn't figure it out.

This should have been more clearly stated as the "demos." We aren't shipping much sample data within sciview, and things like the CREMI data are fetched from a remote source and cached locally.

ctrueden commented 1 year ago

Thanks guys. FWIW, I force-pushed the simvis branch to get rid of the erroneously committed models (@PowerOfNames told me that their addition was unintentional), so now the repo is only is only 16MB! :tada:

kephale commented 3 months ago

I'm closing this. I think the way the underlying need should be addressed is by providing more examples based on https://github.com/scenerygraphics/minimal-sciview-example-project and keeping the examples we have in the main repo.