search

glotaran / pyglotaran

A Python library for Global and Target Analysis of time-resolved spectroscopy data
GNU Lesser General Public License v3.0
52 stars 18 forks source link

📚 Rewrite quickstart to use pyglotaran_extras #1252

Open s-weigand opened 1 year ago

s-weigand commented 1 year ago

Version information

0.7.0.dev and below

Quickstart/Cheat-Sheet

Describe the issue

Right now the Quickstart/Cheat-Sheet demonstrates how to plot using the bare xarray interface. The pyglotaran_extras were created to get a quick and convenient feedback about the results the parameter estimation yields and not dwell on data selection, xarray datastructure and matplotlib plotting refinement details, also well all allowing plot refinement after using one of those convenience functions. So the quickstart promotes a workflow that has an unnecessarily steep learning curve and most users won't use after.

Expected documentation

A quickstart that demonstrates an actual user workflow, not blanking out on the existence of pyglotaran_extras. We have an ecosystem and pyglotaran does not exist in a vacuum no shame in promoting other parts of the ecosystem if that makes user life easier.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 10 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 4 months ago

This issue has been closed due to lack of recent activity. Please open a new issue if you're still encountering this problem. Thanks for your contributions!

stale[bot] commented 1 month ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

jsnel commented 1 month ago

Will get around to this eventually, keep open as a reminder.