Make clearer why we think pyvusim is a reference simulator

[dannyjacobs]

Its not clear to the casual reader why the combination of analytic tests, continuous integration, reference simulations, documentation, community standards, and code publication adds up to pyuvsim being the root name certificate for interferometry simulators needing to demonstrate accuracy sufficient for 21cm cosmology. This pull request addresses that issue with edits to the README, addition of necessary memos, references to papers (some still in prep), and potentially, some re-organization of memos/reference simulations.

Description

• Update and expand the README, sharpening the language
• TODO: add an overview memo describing analytic tests. (point sources, polarized point sources, diffuse sources)
• TODO (maybe): Clean up the reference simulation directories.

Motivation and Context

• Potential users are not aware of the plan and work behind pyuvsim
• Addresses issue Write a memo about analytic tests (point sources, point at paper for diffuse) #312

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Reference simulation update or replacement
• Documentation change (documentation changes only)
• Version change
• Build or continuous integration change

Checklist:

Bug fix checklist:

• My fix includes a new test that breaks as a result of the bug (if possible).
• All new and existing tests pass.
• I have checked that I reproduce the reference simulations or if there are differences they are explained below (if appropriate). If there are changes that are correct, I will update the reference simulation files after this PR is merged.
• I have updated the CHANGELOG.

New feature checklist:

• I have added or updated the docstrings associated with my feature using the numpy docstring format.
• I have updated the documentation to highlight my new feature (if appropriate).
• I have added tests to cover my new feature.
• All new and existing tests pass.
• I have checked that I reproduce the reference simulations or if there are differences they are explained below (if appropriate). If there are changes that are correct, I will update the reference simulation files after this PR is merged.
• I have updated the CHANGELOG.

Breaking change checklist:

• I have updated the docstrings associated with my change using the numpy docstring format.
• I have updated the documentation to reflect my changes (if appropriate).
• My change includes backwards compatibility and deprecation warnings (if possible).
• I have added tests to cover my changes.
• All new and existing tests pass.
• I have checked that I reproduce the reference simulations or if there are differences they are explained below (if appropriate). If there are changes that are correct, I will update the reference simulation files after this PR is merged.
• I have updated the CHANGELOG.

Reference simulation update or replacement:

• If this is a new reference simulation or if the settings files have changed, I have added all the relevant files to the reference_simulations folder.
• If this is a new reference simulation I have fully documented it in a memo in docs and updated any other docs as appropriate.
• I have updated the CHANGELOG.

Documentation change checklist:

• Any updated docstrings use the numpy docstring format.
• If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

Version change checklist:

• I have updated the CHANGELOG to put all the unreleased changes under the new version (leaving the unreleased section empty).
• I have run the appropriate tests for this level of version change (described in the readme under versioning).

Build or continuous integration change checklist:

• If required or optional dependencies have changed (including version numbers), I have updated the readme to reflect this.
• If this is a new CI setup, I have added the associated badge to the readme and to references/make_index.py (if appropriate).

[codecov]

Codecov Report

Merging #320 into master will increase coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #320      +/-   ##
==========================================
+ Coverage   99.11%   99.23%   +0.11%     
==========================================
  Files          12       12              
  Lines        1918     2083     +165     
==========================================
+ Hits         1901     2067     +166     
+ Misses         17       16       -1     

Impacted Files	Coverage Δ
pyuvsim/mpi.py	100.00% <0.00%> (ø)
pyuvsim/uvsim.py	98.86% <0.00%> (+0.72%)	⬆️
pyuvsim/antenna.py	95.94% <0.00%> (+2.46%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1a60856...c45079e. Read the comment docs.

[dannyjacobs]

Any reason not to merge in this doc update?

[dannyjacobs]

Errant text file deleted.
@bhazelton Did you say you had a comment on this PR? I don't see any, but its entirely possible I'm missing it.

[bhazelton]

oops, apparently this was a pending comment rather than a posted one. Sorry!

[bhazelton]

Looks good.