search

SciKit-Surgery / scikit-surgery

SciKit-Surgery - Compact Libraries for Surgical Navigation
http://scikit-surgery.github.io/scikit-surgery/
Other
39 stars 11 forks source link

Decide project structure for simple utility/test/demo apps #32

Closed thompson318 closed 4 years ago

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 10, 2018, 09:27

If we want people to quickly do research, this will (or should) end up with lots of small python scripts that are complete apps/demos/utilities.

So, do we have each in separate packages, so you only pip install the bare minimum you need, or for things that are related, like lots of small video processing apps, bundle them together some how.

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 10, 2018, 09:43

@StephenThompson @ThomasDowrick - your thoughts?

In the first instance I had scikit-surgeryvideolag, and I was just learning how to make an app. Now I have a second one, just to display april tags on the screen, with labels so you can see which ones are detected, and a key press just to grab video image and save to file.

Its small apps like these that im thinking of.

Researchers will very often just want to grab data, and go back to "algorithm development", so they should be empowered to write their own apps, (or else they expect us to do it). But then they probably won't properly maintain a completely independent package. A new package per small app is possibly overkill, and they will be bamboozled by all the necessary files.

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 11, 2018, 12:48

Maybe we need to think about the end users.

Are they;

Surgeons, who'll expect some sort of GUI application specific to their surgery.

Researchers, who I envisage would be best to use the libraries with python, so they can shunt data around easily, and who may want to hack at the libraries and create their own.

Developers, who'll assemble the libraries into applications.

So I'm not sure who the end user is for command line entry points.

thanks and regards,

Steve.

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 11, 2018, 12:50

Following discussion: Im not discussing the virtues of running a command line program versus running python then a script name.

Im just saying, if we have multiple small utility programs, do we bundle multiple programs into one package, or have multiple packages, each with one small app

The decision was for the former. Bundle them into sensible packages.

e.g.

scikit-surgeryvideoutils containing app A, B, C, D.

rather than

scikit-surgeryvideoutilA scikit-surgeryvideoutilB scikit-surgeryvideoutilC scikit-surgeryvideoutilD

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 11, 2018, 12:50

closed