NBDiff Documentation Release 1 Shurouq Abusalah, Tavish Armstrong, Marwa Malti, Lina Nouh, Borislav Pipev, Selena Sachdeva, Richard Tang August 26, 2014 Contents 1 Proposal 3 1.1 Preamble.................................................3 1.2 Proposal.................................................3 1.3 Challenges................................................3 1.4 Conclusion................................................4 1.5 References................................................4 2 Vision Document 5 2.1 Introduction...............................................6 2.2 User Description.............................................6 2.3 Product Overview............................................8 2.4 Feature Attributes............................................9 2.5 Product Features.............................................9 2.6 Exemplary Use Cases.......................................... 10 2.7 Quality Ranges.............................................. 10 2.8 Precedence and Priority......................................... 10 2.9 Other Product Requirements....................................... 10 2.10 Documentation Requirements...................................... 10 2.11 Glossary................................................. 11 3 Project Management Plan 13 3.1 Identification............................................... 14 3.2 Team and Responsibilities........................................ 14 3.3 Work Breakdown Structure, Tasks and Planning............................ 15 3.4 Resource Identification.......................................... 19 3.5 Relationships with project stakeholders................................. 19 3.6 Communication............................................. 20 3.7 System Requirements and Project Input Data.............................. 20 3.8 Configuration Management....................................... 20 3.9 Software Configuration Management.................................. 20 3.10 Documentation Configuration Management............................... 21 3.11 Software Development Management.................................. 21 3.12 Software Development Process..................................... 21 3.13 Software Development Tools....................................... 21 3.14 Software Development Rules and Standards............................... 22 3.15 Test Phases Management......................................... 22 3.16 Problem Resolution........................................... 23 i 4 Activity Plan 25 5 Hour Tracking 27 5.1 1. Milestone 1.............................................. 27 5.2 2. Milestone 2.............................................. 27 5.3 3. Milestone 3.............................................. 28 5.4 4. Milestone 4.............................................. 28 5.5 5. Milestone 5.............................................. 28 5.6 6. Milestone 6.............................................. 28 6 Earned Value Management 31 7 Data 33 8 Graphs 35 9 User Interface Specification 37 9.1 List of Figures.............................................. 37 9.2 Introduction............................................... 38 9.3 User Centered Design.......................................... 38 9.4 Overall User Interface Architecture................................... 40 9.5 Navigation................................................ 40 9.6 Feedback................................................. 41 9.7 Screen Layout.............................................. 41 9.8 Business Rules.............................................. 44 9.9 Future Enhancements.......................................... 44 10 Software Requirements Specification 45 10.1 List of Figures.............................................. 47 10.2 Introduction............................................... 47 10.3 Overall Description........................................... 48 10.4 Specific Requirements.......................................... 50 10.5 Non-Functional Requirements...................................... 51 10.6 Design Constraints............................................ 52 10.7 Documentation Requirements...................................... 52 10.8 Purchased Components......................................... 52 10.9 Licensing Requirements......................................... 53 10.10 Legal, Copyright and Other Notices................................... 53 10.11 Analysis Models............................................. 53 10.12 Information on Version Control Systems................................ 61 11 Diffing-Related Use Cases 71 11.1 ID: DUC1 - Diff Notebooks Locally from Version Control....................... 72 11.2 ID: DUC2 - Diff Notebooks Locally from Files............................. 74 11.3 ID: DUC3 - Diff from Notebooks on A Remote Server......................... 76 12 Merging-Related Use Cases 77 12.1 ID: MUC1 - Locally Resolve Merge Conflicts in Notebooks in Version Control............ 78 12.2 ID: MUC2 - Locally Resolve Merge Conflicts in Notebooks from the Filesystem........... 80 12.3 ID: MUC3 - Merge Notebooks Located on A Remote Server...................... 82 12.4 ID: MUC4 - Resolve Merge Conflicts Remotely in Version Control Pull Request........... 84 13 Scoped-out Use Cases 85 13.1 ID: DUC4 - Selective Staging...................................... 86 ii 14 Risk Management Plan 87 14.1 Introduction............................................... 87 14.2 Roles and Responsibilities........................................ 87 14.3 Risk Assessment............................................. 88 14.4 Risk Analysis............................................... 88 14.5 Risk Control............................................... 89 15 Software Architecture Document 91 15.1 List of Figures.............................................. 91 15.2 Introduction............................................... 92 15.3 Architectural Representation....................................... 93 15.4 Architectural Requirements: Goals and Constraints........................... 94 15.5 Scenarios................................................. 95 15.6 Logical View............................................... 95 15.7 Development View............................................ 106 15.8 Process View............................................... 108 15.9 Deployment View............................................ 108 15.10 Size and Performance.......................................... 109 15.11 Quality.................................................. 110 15.12 References................................................ 111 16 Test Plan Document 113 16.1 List of Figures.............................................. 114 16.2 Introduction............................................... 114 16.3 Compatibility Testing.......................................... 115 16.4 Regression Testing............................................ 123 16.5 Acceptance Testing............................................ 123 16.6 Alpha Testing............................................... 123 16.7 Beta Testing............................................... 123 16.8 Performance Testing........................................... 124 16.9 Usability Testing............................................. 124 16.10 Defects/Bugs Management........................................ 124 16.11 Maintenance Testing........................................... 124 17 Test Summary Report 125 17.1 List of Figures.............................................. 125 17.2 Introduction............................................... 125 17.3 Test Summary.............................................. 125 17.4 Test Assessment............................................. 126 17.5 Test Tesults................................................ 126 18 Comparison of Existing Diff/Merge Tools 139 18.1 Overview................................................. 139 19 New Requirements for Capstone Projects 201 19.1 Impact OF engineering on society.................................... 201 19.2 Ethics and equity............................................. 201 19.3 Professionalism.............................................. 201 19.4 Economics................................................ 202 19.5 Lifelong Learning............................................ 202 20 Glossary 203 21 Authors 205 iii 22 Indices and tables 207 iv NBDiff Documentation, Release 1 Contents: Contents 1 NBDiff Documentation, Release 1 2 Contents CHAPTER 1 Proposal 1.1 Preamble The IPython Notebook is a “web-based interactive computational environment where you can combine code execution, text, mathematics, plots and rich media into a single document.”[1] For scientists, this means a new way of doing the work they have always done: combine observations, results, and analysis in a single document. Historically, this analogue notebook would be the basis for a scientific paper. Today, this electronic IPython Notebook is the scientific paper. Scientists are moving more of their work onto computers and applying software solutions and so they are adopting more of the tools of the software trade. One important tool they have adopted—one that software engineers have been using for decades—is version control. For scientists, this means knowing the ways in which their scientific paper has changed since their last publication; having a precise understanding of who contributed what to each paper revision; and more. It also enables scientists to share their work with other scientists in their field, improving upon peer review methods. However, sharing involves a clear and precise understanding