search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
11 stars 36 forks source link

napari applications tutorials #57

Open sofroniewn opened 4 years ago

sofroniewn commented 4 years ago

Following napari/napari.github.io#42 we are adding an Applications section that can contain more advance tutorials highlighting specific applications.

As discussed with @tlambert03 it's probably good to have these separate from the more basic introductory tutorials so that new comers and beginners aren't overwhelmed.

I also see these as slightly different from blog posts as I'd like them to be maintained and updated with time (as following a napari breaking api change), whereas a blog post I see as more capturing the state at a moment in time (though obviously they can be updated too).

I'd also love for these to be community contributed as much as possible too, so maybe after we have a couple more example ones in we could make a Contributing Guide to set expectations. I see these as more didactic and in-depth then just here's cool data viewed in napari, for that I'd like to have some form of community contributed gallery, as discussed with @jni

How does this sound to everyone?

To also keep the convo going here are a couple ideas for posts:

ruhmamehek commented 4 years ago

Hi, I find 'lazy parameter sweep with dask' interesting, and I would like to try writing a tutorial on this. Can I please take this up?

jni commented 4 years ago

@ruhmamehek yes, please give it a go! I would recommend having a look at the example in my blog post, which was a real-world use case mixing both an image and a points layer.

sofroniewn commented 4 years ago

That would be amazing! It might be great to use magicgui made by @tlambert03 (who is also a napari core developer) to provide GUI interactivity for the parameter sweep

tlambert03 commented 4 years ago

... but, erm, let me update that magicgui tutorial a bit before you get too far with it 😅. there is at least one thing (register_type) in there that is a bit out of date.

tlambert03 commented 4 years ago

updated the param sweep example in the docs

ruhmamehek commented 4 years ago

Hi, I have added a tutorial for lazy parameter sweep with dask. I have added an example for parameter sweep using magicgui with napari as well. Looking forward to your reviews and suggestions.

tlambert03 commented 4 years ago

Thank you @ruhmamehek! I'm excited to look through it and will comment shortly!

chili-chiu commented 2 years ago

@sofroniewn curious which ones on the list you think would be good to add to the documentation, given the development over the past few years? 😁

sofroniewn commented 2 years ago

hmm, i'm not sure - we now have a many more plugins to draw on too curious what others think here? We could bring this convo to zulip / twitter for more folks to make requests too. Maybe we could do a poll?