Sk/joss 1

[skeating]

Description

Fixes #{issue_number}: A few words or sentences describing the changes proposed in this pull request (PR).

Type of change

Please delete options accordingly to the description.

• 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 not work as expected)
• This change requires a documentation update

Suggested Checklist

• I have performed a self-review of my own code.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• I have commented my code, particularly in hard-to-understand areas.
• I have passed on my local host device. (see further details at the CONTRIBUTING document)
• Make sure your branch is up-to-date with main branch. See CONTRIBUTING for a general example to syncronise your branch with the main branch.
• I have requested review to this PR.
• I have addressed and marked as resolved all the review comments in my PR.
• Finally, I have selected squash and merge

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.30%. Comparing base (76e35fc) to head (93dc6ba).

Additional details and impacted files

@@             Coverage Diff              @@
##           sk/joss-pub     #529   +/-   ##
============================================
  Coverage        87.30%   87.30%           
============================================
  Files               76       76           
  Lines             3442     3442           
============================================
  Hits              3005     3005           
  Misses             437      437           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[skeating]

I am aware this is not going to work totally because some files have not been created yet but I would like review of the main read me to see if I am heading in the right direction

[stefpiatek]

Sorry taken so long, yeah this is a reasonable direction for sure