Comments (17)
cool - I'll take a pass at this after the holiday!
from jupyter-book.
OK, @Carreau said that he'd help me get this transfered to the jupyter org next week, so I can make a release once that happens :-)
from jupyter-book.
hmmmmmm.....that's a good point, I haven't ever thought about this :-)
What would you recommend? I could write up a short blurb and submit it to JOSS?
from jupyter-book.
I'm a big fan of cutting DOIs with Zenodo. The integration is quite easy to set up, too, and means that I could cite your code quickly.
I don't think this would preclude submission to JOSS -- I don't have any personal experience there, but I've heard great things !
from jupyter-book.
Cool - lemme check it out and will report back :-)
from jupyter-book.
I looked into the guide you linked and, yeah! that is pretty simple!
Two quick questions:
- Do you know anything about the relative merits of zenodo vs figshare? I know others who have used figshare but I also heard it's not really an open service
- Do you know how zenodo handles new versions of software? E.g. if I create a DOI for v0.2, do I have to change the DOI for each new version? Is that much of a hassle?
Thanks for your guidance :-)
from jupyter-book.
@emdupre pinging you in case you're not watching this thread
from jupyter-book.
Thanks for checking it out ! To give some (hopefully helpful) answers:
-
I use figshare for presentations (where I want them to by easily visualized in browser) but prefer zenodo for code -- partially because the integration is so easy ! I do know that figshare is privately funded and zenodo is funded through CERN, so I'm not sure if that's why GitHub decided to push the zenodo integration over the figshare one. But it seems to have had an effect, with more code being hosted on zenodo than figshare.
-
If you set up the zenodo integration, as soon as you cut a new release on GitHub it cuts a new DOI on Zenodo. It actually cuts two DOIs for your sotware: one for the "concept" of the library, and one for the specific version. The concept DOI stays stable across all releases, but the version-specific one will update.
This can make it a (small) pain to keep your docs sync'ed if you're embedding the version-specific DOI badge in your documentation. One solution Chris G came up with that I quite like (and use in my own projects) is to run some javascript and grab the most up to date version-specific DOI through their API. You can see how I'm embedding it in a sphinx site here.
Let me know if that answers your questions, and thanks again ✨
from jupyter-book.
ah that's good to know about the 2 different kinds of citations.
I'm thinking of waiting until https://github.com/choldgraf/jupyter-book/pull/38 and https://github.com/choldgraf/jupyter-book/pull/48 and https://github.com/choldgraf/jupyter-book/pull/27 land before cutting a new release. Are you fine w/ the last beta release as the DOI?
from jupyter-book.
Yes, that's totally fine ! Whatever makes sense to you -- I'm just looking for something to cite 😄
from jupyter-book.
Just stumbled upon this, and I wanted to mention that this would also fit perfectly at the Journal of Open Source Education (JOSE) if you decide to submit this somewhere. It's a sibling of JOSS and they say:
"JOSE accepts two types of submissions: (1) computational learning modules, created as open educational resources (OER), and (2) open-source software, created as educational technology or infrastructure. "
from jupyter-book.
I agree! Though I've been checking off and on for the last several months and it seemed like they still weren't accepting submissions. Do you know if the submission process is open now?
from jupyter-book.
Yeah! You should be able to submit here that will start a review process like this which usually has a quick turn around time.
from jupyter-book.
@emdupre think the citation can wait until this goes through the JOSE process? :-)
from jupyter-book.
Totally up to you, but I'm not sure the zenodo DOI would be mutually exclusive, here ! Having a DOI seems to be ok for submitting at JOSS, at least.
from jupyter-book.
one more question: if I cut a DOI now, but then move this repository to another org, will that break the DOI?
from jupyter-book.
That's a great question. I tried looking into it, but I really can't find anything... GitHub will do the automatic redirects, so it might be ok ? But I can't find concrete documentation, sorry !
from jupyter-book.
Related Issues (20)
- File path on toc does't seem to work when pointing outside of book folder HOT 1
- docutils/transforms/misc.py error HOT 1
- for _config and _toc files, only `yml` extension is recognized not `yaml` HOT 1
- AttributeError: 'EntryPoints' object has no attribute 'get' HOT 1
- KeyboardInterrupt when compile the book HOT 3
- Horizontal scrolling missing for itables within ipywidget tabs HOT 1
- Imprecise description of round on page /pages/data_types/coercion.html HOT 1
- Default Jupyter Book build web accessibility issues HOT 1
- code-cell using new/strange font -- how to revert to a fixed-width font? HOT 2
- Add feature in `_config.yml` to change sidebar logo URL HOT 1
- Error No such file or directory: '//anaconda3/bin/python' HOT 2
- sphinx==7.3 breaks builds HOT 2
- Issue on page /intro.html HOT 1
- Display math in admonition HOT 1
- AttributeError: 'EntryPoints' object has no attribute 'get' HOT 3
- Underscore in title doesn't get properly escaped for pdflatex build target, causing formatting errors HOT 1
- Issue on page /week2/DL_adaptLR.html HOT 1
- Issue on page /week2/DL_adaptLR.html HOT 1
- Can't build book on mac when folder name is not project name. HOT 1
- Dark mode doesn't properly style collapsed code blocks
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jupyter-book.