<div dir="ltr">Hello,<div><br></div><div>I'll take the chance for the following comment (which builds up upon</div><div>comments I made in past telecons).</div><div><br></div><div>I don't know what is the process to propose a change in the guidelines,<br></div><div>but I would like to make the following proposal:</div><div><br></div><div>* New/updated thorns should add a gallery example upon inclusion or </div><div> significant update, *</div><div><br></div><div>Rationale:</div><div><br></div><div>The latest release of the Einstein Toolkit contains roughly 300 thorns</div><div>(including the ones that are disabled). However, there are only 5 curated</div><div>examples (ie, the gallery examples) on how to do things. This means,</div><div>among the other things, that:</div><div>- The vast majority of thorns do not have an example on how to use them.</div><div> One can look at test files, but they are often not reflective of real-world use.</div><div> Some thorns come with par files, but they are not tested and might no</div><div> longer work.</div><div>- There is a discoverability problem. It is impossible to know what the Einstein</div><div> Toolkit can do and what it cannot do. </div><div>- It is hard to perform new and different simulations (unless you have a lot </div><div> of experience). This is especially relevant for new users, which have only</div><div> a handful of curated examples to look at. On the flip side, it is easy to make</div><div> mistakes, given that one will likely copy&paste parameters without </div><div> understanding what they do. </div><div>Overall, I believe that having more gallery examples will make the toolkit<br></div><div>more user-friendly. </div><div><br></div><div>Typically, developers already have some parameter files that they have used</div><div>for their work/publication, so, I would expect that cleaning it up should not be</div><div>too much of an added burden. The actual extra burden that this change introduces</div><div>is that there will be more gallery examples that have to be tested upon release.</div><div><br></div><div>What do you think?</div><div><br></div><div>Best,</div><div>Gabriele</div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Aug 2, 2022 at 8:17 AM Roland Haas <<a href="mailto:rhaas@illinois.edu">rhaas@illinois.edu</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello all,<br>
<br>
Since I am serving as release manager for the upcoming release and<br>
could not find this information collated in a single location I started<br>
to draft a reviewer's guide for contributions (slightly different from<br>
the how to review a patch guide<br>
<a href="https://docs.einsteintoolkit.org/et-docs/How_to_Review_a_Patch" rel="noreferrer" target="_blank">https://docs.einsteintoolkit.org/et-docs/How_to_Review_a_Patch</a> that<br>
already existed):<br>
<br>
<a href="https://docs.einsteintoolkit.org/et-docs/How_to_Review_a_new_component" rel="noreferrer" target="_blank">https://docs.einsteintoolkit.org/et-docs/How_to_Review_a_new_component</a><br>
<br>
Comments and contributions (you may have to send email first to have an<br>
account on the wiki created) would be very welcome.<br>
<br>
Yours,<br>
Roland<br>
<br>
-- <br>
My email is as private as my paper mail. I therefore support encrypting<br>
and signing email messages. Get my PGP key from <a href="http://pgp.mit.edu" rel="noreferrer" target="_blank">http://pgp.mit.edu</a> .<br>
_______________________________________________<br>
Users mailing list<br>
<a href="mailto:Users@einsteintoolkit.org" target="_blank">Users@einsteintoolkit.org</a><br>
<a href="http://lists.einsteintoolkit.org/mailman/listinfo/users" rel="noreferrer" target="_blank">http://lists.einsteintoolkit.org/mailman/listinfo/users</a><br>
</blockquote></div>