Add SmartSim Zoo Info to Docs

[EricGustin]

This PR adds a section about the SmartSim Zoo to the documentation. A page about the Zoo has been added in the "Getting Started" section.

[EricGustin]

The title for the new page is currently "Contributing Examples", but I'd be open to naming it "SmartSim Zoo" or something entirely different.

[codecov-commenter]

Codecov Report

Merging #175 (7134292) into develop (3efd2a0) will increase coverage by 0.06%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop     #175      +/-   ##
===========================================
+ Coverage    81.20%   81.27%   +0.06%     
===========================================
  Files           57       57              
  Lines         2910     2910              
===========================================
+ Hits          2363     2365       +2     
+ Misses         547      545       -2     

Impacted Files	Coverage Δ
smartsim/_core/launcher/taskManager.py	79.88% <0.00%> (+1.18%)	⬆️

[ashao]

Sorry, I posted this to the issue instead of the PR.

Nice start to documenting the SmartSim Zoo @EricGustin! There's some additional work that could be done for this though to make the purpose of the Zoo more clear to the community and also help folks have a similar experience when they're browsing the zoo. Some of the difficulty in this is that we have a bit of a hodgepodge of things we're describing in the zoo; the actual source code is more about getting SmartSim examples up and running on the machine, but the README.md describes some of the larger applications that we have. Both of these are useful, but may draw the attention of different audiences.

I propose in the documentation mention that we have two large categories: SmartSim deployments (i.e. what people have to do to get SmartSim running on a particular HPC platform) and SmartSim applications (i.e. what project has someone completed, is doing with SmartSim)

For the latter, we should have a general contribution template where we suggest the kind of things that someone browsing through the zoo will find useful. I'd suggest saying something like:

• Title of the project
• High-level description (the 'elevator pitch')
• SmartSim features used (e.g. online analysis, ensemble), this could almost be a curated list of tags that we suggest
• Prerequisites: hardware and software
• Installation guide
• Quickstart
• Contact information
• Citation

Do you want to take a quick stab at writing something like that up? Let me know if you want to ideate on this with me. Also, take a look at some other examples of zoos:

• https://catalog.ngc.nvidia.com/orgs/nvidia/teams/nemo/models/ner_en_bert
• https://paperswithcode.com/

Just to clarify, we're not in a place where we can have the same UI as something like them, but this exercise is more of an effort to ensure that we gather up all the information that we need.

[ashao]

Thanks for the edits. Couple of changes to suggest to make it slightly more descriptive.

[ashao]

Great job!