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

D4.6: Tools for collaborating on notebooks via version-control #95

Closed
minrk opened this issue Sep 8, 2015 · 11 comments
Closed

D4.6: Tools for collaborating on notebooks via version-control #95

minrk opened this issue Sep 8, 2015 · 11 comments

Comments

@minrk
Copy link
Contributor

@minrk minrk commented Sep 8, 2015

Version control tools, such as Git and Mercurial, have become an integral part of open and collaborative science and software. Version control tools allow proposed changes to be reviewed ('diffing') and resolve conflicts through combination of changes ('merging'). Jupyter notebook documents are stored in text files as JSON formatted data. This makes them well suited to tracking in version control, but the JSON structure can make diffing and merging difficult.

For this deliverable, we have developed the nbdime tool for diffing and merging notebook documents with awareness of the structured nature of the documents, allowing a significantly improved experience over naïve text-file diffing and merging tools. nbdime can be integrated into the popular git version control system, maximizing impact on common developer workflows.

@minrk minrk added this to the D4.6 milestone Sep 8, 2015
@minrk minrk self-assigned this Nov 3, 2015
@martinal
Copy link

@martinal martinal commented Dec 18, 2015

Prototyping and discussion har started at

jupyter/enhancement-proposals#8

https://github.com/martinal/nbdime

This issue will be updated only when a major release of the new software is ready, follow the above to join the discussion and work in progress.

@bpilorget
Copy link
Contributor

@bpilorget bpilorget commented Aug 30, 2016

Is the report close to an end?

@minrk
Copy link
Contributor Author

@minrk minrk commented Aug 30, 2016

@bpilorget yes, currently finishing it up at #199

@bpilorget
Copy link
Contributor

@bpilorget bpilorget commented Aug 30, 2016

@minrk Perfect
The README gives info on how to write deliverables (scroll down): https://github.com/OpenDreamKit/OpenDreamKit

@minrk
Copy link
Contributor Author

@minrk minrk commented Aug 31, 2016

@bpilorget the D4.6 report should be complete and ready for submission now.

@nthiery
Copy link
Contributor

@nthiery nthiery commented Sep 4, 2016

Hi Min, Martin,

I have just been through the report and it looks good! Great job on nbdime; that's a major feature, well delivered on time!

I have made minor formating changes; see the commits.

I believe the importance of nbdime could be further highlighted in the report by a short discussion about its relevance to reproducible research, in particular in connection with the upcoming #98: fostering the use of version control leads to better tracability, etc. Could you add such? Then I'll upload the report on the EU web site.

Oh, by the way, thinking about #98 and the comment in the report about the handling of output: if a notebook is used for testing, then it's not necessarily an option to just discard the output and rerun the notebook.

Cheers,

@minrk
Copy link
Contributor Author

@minrk minrk commented Sep 5, 2016

@nthiery on it, will push by the end of today. I will also clarify the comments about output - it is not that output is ignored, but that different choices may be made about changes in generated output, depending on circumstances.

@minrk
Copy link
Contributor Author

@minrk minrk commented Sep 5, 2016

@nthiery added note about reproducibility, #98.

@bpilorget
Copy link
Contributor

@bpilorget bpilorget commented Oct 24, 2016

Deliverables update

@minrk As you know , during the interim review in Bremen, reviewers gave advice to improve deliverables. UPSud tried to follow their advice by updating D5.1 #107
The main critic is that deliverables should be static document. Therefore we went through the #107 report to check if all links were still working and also if the information contained on the links was necessary for the understanding of the report.
As a result when it was necessary annexes were added to the #107 report.

Can you please do the same for this deliverable and add annexes when need be?

@minrk
Copy link
Contributor Author

@minrk minrk commented Dec 16, 2016

This is delivered.

@nthiery
Copy link
Contributor

@nthiery nthiery commented Jan 4, 2017

Report submitted to the EU portal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.