Joss paper

[barneydobson]

Description

• Prepare the JOSS paper file.
• Link the paper as an 'about' section in documentation. ~(You can view it with mkdocs serve)~ Now a pdf that is compiled on publish.
• fix link for coverage

@cheginit this is a super quick draft I thought I'd prepare for a JOSS paper. I've just gone for something similar to the WSIMOD one. I haven't checked in detail at all and definitely need to polish it - but just wanted to check that you're happy with the broad format (i.e., summary = 1 para, statement of need = 1 para literature + 1 para software, outlook/limitations = 1 para). In particular I'm aware the literature para needs some significant improvement!

OK I've actually reduced it and moved the literature into the summary, but I think it works better, LMK what you think (@cheginit )

Fixes #337

Type of change

• [x] Documentation (non-breaking change that adds or improves the documentation)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Optimization (non-breaking, back-end change that speeds up the code)
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] Breaking change (whatever its nature)

Key checklist

• [x] All tests pass (eg. python -m pytest)
• [x] The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
• [x] Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• [ ] Code is commented, particularly in hard-to-understand areas
• [ ] Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.79%. Comparing base (fb919bc) to head (99167e8). Report is 2 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #313 +/- ## ========================================== + Coverage 87.77% 87.79% +0.01% ========================================== Files 22 22 Lines 2217 2220 +3 Branches 280 280 ========================================== + Hits 1946 1949 +3 Misses 194 194 Partials 77 77 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[cheginit]

The structure is good. Just try to keep it below 1000 words.

[barneydobson]

@cheginit any closing remarks for this?

[cheginit]

I added some comments. Also, please make sure that you can successfully compile the paper locally following JOSS's instructions here.