Add JOSS paper citation info

hajdik commented 1 year ago

Purpose

Add separate citation page in docs like the one in pyOptSparse
Update readme for docs link and JOSS badge
Add citation.cff which adds citation info to right bar of GitHub repo where the bibtex can be copied from

I don't know if the mention of the conference paper on the citation docs page should be phrased differently, let me know if you have other ideas.

Expected time until merged

a day or two

Type of change

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (non-backwards-compatible fix or feature)
[ ] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no API changes)
[x] Documentation update
[ ] Maintenance update
[ ] Other (please describe)

Testing

Docs test passes and everything looks okay

Checklist

[ ] I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
[ ] I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
[ ] I have run unit and regression tests which pass locally with my changes
[ ] I have added new tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation

codecov[bot] commented 1 year ago

Codecov Report

Merging #212 (708c090) into main (a786045) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #212   +/-   ##
=======================================
  Coverage   64.76%   64.76%           
=======================================
  Files          47       47           
  Lines       12018    12018           
=======================================
  Hits         7784     7784           
  Misses       4234     4234

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

marcomangano commented 1 year ago

@anilyil can you go ahead and merge? Need override authority because the doc build is a required test

mdolab / pygeo