Joss paper

[ryanmrichard]

This PR contains the JOSS manuscript (well the source code for it). The JOSS GitHub action will turn that source code into the actual manuscript.

We have no intention of merging this branch with master, rather this PR serves as a central location for collaborating on the manuscript.

For reference:

• this is what JOSS recommends putting in the paper.
• Papers need to be 500 to 1000 words (we're at like 900).

[codecov[bot]]

Codecov Report

Base: 96.05% // Head: 96.80% // Increases project coverage by +0.74% :tada:

Coverage data is based on head (8243c1f) compared to base (f5e67ea). Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #104 +/- ## ========================================== + Coverage 96.05% 96.80% +0.74% ========================================== Files 7 6 -1 Lines 837 719 -118 ========================================== - Hits 804 696 -108 + Misses 33 23 -10 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `96.80% <100.00%> (+0.74%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/CMakePP/CMinx/pull/104?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP) | Coverage Δ | | |---|---|---| | [src/cminx/aggregator.py](https://codecov.io/gh/CMakePP/CMinx/pull/104/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2FnZ3JlZ2F0b3IucHk=) | `92.88% <100.00%> (+0.68%)` | :arrow_up: | | [src/cminx/config.py](https://codecov.io/gh/CMakePP/CMinx/pull/104/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2NvbmZpZy5weQ==) | `100.00% <100.00%> (ø)` | | | [src/cminx/documentation\_types.py](https://codecov.io/gh/CMakePP/CMinx/pull/104/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2RvY3VtZW50YXRpb25fdHlwZXMucHk=) | `98.70% <100.00%> (+0.06%)` | :arrow_up: | | [src/cminx/\_\_init\_\_.py](https://codecov.io/gh/CMakePP/CMinx/pull/104/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L19faW5pdF9fLnB5) | | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[ryanmrichard]

@AutonomicPerfectionist Thanks for your changes. I made your changes, and that then inspired me to massively reconfigure the paper (the content is largely the same, but in a different presentation). I'm pretty happy with its current state. So when you get a chance can you give it another read? Thanks in advance.

[ryanmrichard]

@AutonomicPerfectionist it's submitted :tada:

[ryanmrichard]

@peanutfun thanks for your careful reviewing! I went ahead and made those changes.

[peanutfun]

Excellent, thanks a lot!

[ryanmrichard]

Now that the paper is published I'm going to delete this branch and close this PR. If people want to read the paper they can follow the link in the little DOI button.