Docs/generator section refactor

[jlnav]

No description provided.

[shuds13]

• calling script update
• DEAP - shows no functions
• decide layout - top section
• decide layout of generator list - Jeff.
• remove dropdown
• different generators on their own page.
• libE readme should have comm examples link by regression tests link.
• README should name AURORA, FRONTIER, PERLMUTTER - advertise used on exascale systems.
• Decision on what is included at the bottom of the Quick Start (community examples box - inc open/closed)
• Agree my new read me opening line
• whether to have Examples overview section (only place examples_index would appear in docs).
• Check pdf of docs (inc. whether examples overview inclusion has effect)
• Are we adding neural network example?
• Example submission scripts (in HPC section) - include examples in examples/libE_submission_scripts and have link from this section somewhere (maybe in intro with link to HPC info).
• User options:in e.g. start_only_persistsent lost bold - i changed it to highlight - but better how it was originally.
• Check/fix docs build errors/warnings

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.38%. Comparing base (cba6ff6) to head (2fbde00).
Report is 228 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1501   +/-   ##
========================================
  Coverage    78.38%   78.38%           
========================================
  Files           76       76           
  Lines         7697     7697           
  Branches      1144     1144           
========================================
  Hits          6033     6033           
  Misses        1468     1468           
  Partials       196      196           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[shuds13]

Some alternatives for short descriptions.

Have a first page under Examples: which has some curated information (more similar to what's in the drop-down box) and does not have to list every gen_f. Then “Generator Functions” only has a short description under sections. I'm leaning towards this, I dont think this stuff should be in a drop-down anyway.

Try inserting short descriptions for each generator file or gen_f.

Use a table instead which gives greater flexibility to how we can express various information about the generators. This could be one table or it could be a separate table for different sections (in which case the sections would still appear in the left-hand banner). I could try out on a separate branch.

[shuds13]

removed?

[shuds13]

there are occasions where we cant do this

[jmlarson1]

I don't know of cases were we can't import the external local opt before APOSMM

[shuds13]

#1064

If you import PETSc globally when running with openMPI (and using the executor) you have nested MPI (as PETSC imports MPI). So it must be imported in the function in those cases.

[jmlarson1]

Should we add a note to point to this issue with PETSc?

[jlnav]

• Probably remove Overview of Examples page (or comment-out)
• Simpler Ax multipoint gen or example
• Alphabetize within categories
• Sampling, (basic sampling)

[jlnav]

• Have drop-down in quickstart default to open

[jlnav]

Perhaps move "see the tutorial" and "see user guide" under Support or Further Information

[wildsm]

In quickstart, maybe combine the sentences around the bullets into one:
libEnsemble empowers model-driven ensembles to solve design, decision, and inference problems on supercomputers such as Frontier, Aurora, and Perlmutter.

[jlnav]

If possible, little stubs to discuss each sim_f

[jlnav]

"forces" sims are templates rather than "forces" sims?

[jmlarson1]

Should we add a note to point to this issue with PETSc?