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

Generate a DOI (Zenodo) for Citation #158

Closed
vsoch opened this issue Aug 28, 2020 · 7 comments
Closed

Generate a DOI (Zenodo) for Citation #158

vsoch opened this issue Aug 28, 2020 · 7 comments

Comments

@vsoch
Copy link
Contributor

vsoch commented Aug 28, 2020

It might be useful to have qpixel set up with https://zenodo.org/ so that each release will generate an archive programatically. This works by way of connection to GitHub by someone with admin permission to the repository, and then allows for adding a badge to the repository to go to the record. This will fit the use case of a researched (or anyone really!) coming along and wanting to use the software for their work.

@vsoch
Copy link
Contributor Author

vsoch commented Aug 28, 2020

And here is the post that I'm excited to share on Sunday to the RSEng community - please take a look and give feedback! If we get a Zenodo identifier I can update it with that. https://rseng.github.io/rseng/software/qpixel. You can give feedback here or just open a PR to https://github.com/rseng/rseng/tree/gh-pages if it's more extensive.

@cellio
Copy link
Member

cellio commented Aug 28, 2020

And here is the post that I'm excited to share on Sunday to the RSEng community - please take a look and give feedback! If we get a Zenodo identifier I can update it with that. https://rseng.github.io/rseng/software/qpixel. You can give feedback here or just open a PR to https://github.com/rseng/rseng/tree/gh-pages if it's more extensive.

Thanks for sharing! A couple things:

  1. We used Discourse initially, before we had our network up and running, but we've deprecated it in favor of our Meta community.

  2. Researchers might be interested in categories, particularly that they can include things other than just Q&A in their setups if they want to. Articles, glossaries, other resources (depending on the field), even blog posts could be helpful to research teams. I could imagine some research communities using articles for "lab reports" for in-progress experiments that will eventually lead to published research, for example, or whatever inputs are needed to replicate the work.

@ArtOfCode-
Copy link
Member

Done, badge is in the README. Current DOI is 10.5281/zenodo.4006872 for v0.6.1.

@ArtOfCode-
Copy link
Member

And here is the post that I'm excited to share on Sunday to the RSEng community - please take a look and give feedback! If we get a Zenodo identifier I can update it with that. rseng.github.io/rseng/software/qpixel. You can give feedback here or just open a PR to https://github.com/rseng/rseng/tree/gh-pages if it's more extensive.

Nice! Couple of comments:

  • We should refer to the software as Codidact (publicly, at least - its internal name may remain qpixel for differentiation). Joe User doesn't care what the software's name was five years ago, but about how it's referred to now: Codidact.
  • Echo what Monica said about not using Discourse any more. Perhaps worth pointing to as an example of how it's different in your post, but not something we actively use now.
  • There's a typo in your first line: "synthsize" => "synthesize" :)

@vsoch
Copy link
Contributor Author

vsoch commented Aug 28, 2020

Thank you @ArtOfCode- and @cellio !

Researchers might be interested in categories, particularly that they can include things other than just Q&A in their setups if they want to. Articles, glossaries, other resources (depending on the field), even blog posts could be helpful to research teams. I could imagine some research communities using articles for "lab reports" for in-progress experiments that will eventually lead to published research, for example, or whatever inputs are needed to replicate the work.

Hugely +1! On ask.ci (you can type that into the url bar) there are discourse boards that are called "locales" associated with different centers, so the level or organization that community would want is for academic groups.

I've updated the post to change Qpixel references to Codidact, added information on categories, and the zenodo identifier. You can review changes here: rseng/rseng@eab811a or again the draft at https://rseng.github.io/rseng/software/codidact.

Just curious - what did the name "qpixel" originally mean or get at? That might be an interesting factoid to add to the post!

@ArtOfCode-
Copy link
Member

*shrug*

It was a name I picked five years ago when I built the first version of it. No particular meaning to it, really - just a name.

@vsoch
Copy link
Contributor Author

vsoch commented Aug 28, 2020

haha ok :) Thanks for being so speedy to add the DOI - looking forward to sharing this weekend!

@vsoch vsoch closed this as completed Aug 28, 2020
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

No branches or pull requests

3 participants