fleshing out docs

[beykyle]

First crack at fleshing out documentation

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.75%. Comparing base (0c8adfd) to head (bf5a09c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   58.75%   58.75%           
=======================================
  Files          17       17           
  Lines         320      320           
=======================================
  Hits          188      188           
  Misses        132      132           

☔ 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.

[manuelcatacora]

this looks good to me.

[beykyle]

Self review;

• checked out installed and tested code in clean conda env following user guide
• built docs locally and read through them

This branch has basically no functionality on it so this is very simple.

[jared321]

• Reviewed all changes made in branch
  • Please see comments/questions.
• Built both the HTML and PDF output locally with tox and reviewed rendered content
  • The API docs do not reflect the alpha release's interface. Therefore, after this PR is merged, main will likely need to be merged into feature-templates and RTD setup so that "latest" corresponds to the contents of that branch.
• No typos found with the typos tool
• Followed links in rendered docs and confirmed correct.
  • The Jupyter book links show content that is not based on contents in the feature-templates. Therefore, that branch will need to be updated for the alpha release so that it publishes its contents to the public Jupyter book

If links are added/updated, please check them manually before merging.

[jared321]

Both Configuration and Configuration.from_template should be changed to something like :py:class:... once this file is merged with the fully developed Configuration class.

[jared321]

@beykyle During the self review, did you test the pro package installation procedure on one system but with two different MPI implementations? For example, install with Open-MPI first and MPICH a second time? With Taweret, we ran into issues with cached prebuilt wheels. mpi4py docs mention this issue as well.

[beykyle]

@beykyle During the self review, did you test the pro package installation procedure on one system but with two different MPI implementations? For example, install with Open-MPI first and MPICH a second time? With Taweret, we ran into issues with cached prebuilt wheels. mpi4py docs mention this issue as well.

I will do this after merge into feature-templates, in case there is any difference, so that we can verify it works for the branch of the alpha