Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JOSS paper #804

Merged
merged 1 commit into from Sep 15, 2021
Merged

Add JOSS paper #804

merged 1 commit into from Sep 15, 2021

Conversation

ml-evs
Copy link
Member

@ml-evs ml-evs commented May 13, 2021

Hi @CasperWA, @shyamd & @markus1978. Here is a skeleton for JOSS, as discussed in #203. I will try to turn this into a proper draft when I get time, but feel free to comment on the proposed content/structure. I think there is still some discussion to be had in #203 about authorship, so let's continue that over there.

You can now see the preview of the paper in the build artifacts of the CI.

@codecov
Copy link

codecov bot commented May 13, 2021

Codecov Report

Merging #804 (f411b81) into master (c15b0b0) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head f411b81 differs from pull request most recent head d05f882. Consider uploading reports for the commit d05f882 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master     #804      +/-   ##
==========================================
- Coverage   92.78%   92.78%   -0.01%     
==========================================
  Files          67       67              
  Lines        3786     3783       -3     
==========================================
- Hits         3513     3510       -3     
  Misses        273      273              
Flag Coverage Δ
project 92.78% <ø> (-0.01%) ⬇️
validator 92.78% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
optimade/server/config.py 91.20% <0.00%> (-0.10%) ⬇️
optimade/server/schemas.py 100.00% <0.00%> (ø)

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 c15b0b0...d05f882. Read the comment docs.

@ml-evs
Copy link
Member Author

ml-evs commented Jun 5, 2021

Hi all, I think this is now in a shape where it can usefully receive feedback. It would be great to polish and submit during the workshop to cut down on the back-and-forth. Look forward to speaking to you all next week.

Rendered preview (I'll keep the link in the top comment updated): http://res.cloudinary.com/hkvhhndao/image/upload/v1622922921/ijtcez5trenkw2yn0ymw.pdf

I've only chucked the figure in to make it more interesting, I will have to update it as part of my tutorial on Monday anyway, so will see what I can come up with...

@dwinston @CasperWA @markus1978 @fekad @shyamd

shyamd
shyamd previously approved these changes Jun 7, 2021
paper/paper.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dwinston dwinston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest changes via #840

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
@ml-evs
Copy link
Member Author

ml-evs commented Jun 11, 2021

Some updates:

  • Removed figure after discussion with @CasperWA (i.e. me telling him I was doing it)
  • Turned some bibs into inline links where no bib reference is available, e.g. MongoDB.

@ml-evs
Copy link
Member Author

ml-evs commented Jun 11, 2021

After @fekad has taken a look and added his details, I will aim to submit this paper early next week.

We will then have some amount of time in pre-review where we can still make any minor changes (but please do raise any issues before then).

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
@ml-evs
Copy link
Member Author

ml-evs commented Jun 14, 2021

I am submitting this now, and will tag your GitHub accounts in the review. We can still make tweaks on this branch directly (and it will be good to fill out our online docs as suggested in the other PRs).

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
Copy link
Member Author

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use proper journal abbreviations

paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Co-authored-by: Casper Andersen <CasperWA@users.noreply.github.com>
Co-authored-by: Donny Winston <dwinston@users.noreply.github.com>
Co-authored-by: Markus Scheidgen <markus1978@users.noreply.github.com>
Co-authored-by: Shyam Dwaraknath <shyamd@users.noreply.github.com>
Co-authored-by: Adam Fekete <fekad@users.noreply.github.com>
@ml-evs ml-evs marked this pull request as ready for review September 15, 2021 22:34
@ml-evs ml-evs changed the title JOSS paper drafting Add JOSS paper Sep 15, 2021
@ml-evs ml-evs merged commit 2139d84 into master Sep 15, 2021
@ml-evs ml-evs deleted the joss branch September 15, 2021 22:35
@ml-evs ml-evs restored the joss branch September 15, 2021 22:36
@ml-evs ml-evs deleted the joss branch October 26, 2021 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants