Course materials for Research Software Engineering course.
Jupyter Notebook Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ch00python removing dead ipython video links Jun 1, 2018
ch01data fixing some broken swc links Jun 1, 2018
ch02git Fix Python 2 print Nov 2, 2017
ch03tests Merge branch 'master' of https://github.com/UCL/rsd-engineeringcourse Nov 20, 2017
ch04packaging Post lecturing changes Dec 12, 2017
ch05construction
ch07dry Some python3 fixes Dec 18, 2017
ch08performance Some python3 fixes Dec 18, 2017
ch98rubrics Some python3 fixes Dec 18, 2017
session99 moving nose into the just in case install category as it is default i… Oct 4, 2017
site-styles
.gitignore Fix annoying issue with Sphinx? Jul 24, 2015
.travis.yml Merge branch 'stuart-prep' of https://github.com/UCL/rsd-engineeringc… Jun 1, 2018
LICENSE.md Create LICENSE.md Feb 17, 2014
Makefile Fix root URL Jun 9, 2016
README.md
_config.yml Jekyll don't reject sphinx _static Jun 14, 2016
attendee-info.md
bannermidgreen.pdf Add UCL banner Jan 12, 2016
dates.md Rename dates to dates.md Jul 24, 2015
index.md Less specific link for online store registration Jan 4, 2017
intro.md Session 9 and stub for 10 Nov 21, 2014
jekyll.tpl Cleaned up for new stylings Jul 24, 2015
latex.tplx Newer jupyter doesn't need extra tokens defining Jun 6, 2016
nbmerge.py
requirements.txt Update requirements for pytest-cov Nov 14, 2017
secrets.tar.enc

README.md

rsd-engineeringcourse

Course materials for Research Software Engineering course.

Current plan for structure (as advertised):

Research Software Engineering

21st, 28th Feb and 7th, 14th, 21st March 2014 2:00pm - 5:00pm

Content: In this course, you will move beyond programming, to learn how to construct reliable, readable, efficient research software in a collaborative environment. The emphasis is on practical techniques, tips, and technologies to effectively build and maintain complex code. This is a short (15 hours over 5 half-days), intensive, practical course. The content of each of the 5 half-day units is as follows:

  1.   Code management. Collaborating around code. Distributed version control. Git. Github. Issue tracking. Code review and pull requests. Branches and merging. Software licenses. Citing software. Software sustainability.
    
  2.   Testing scientific software. Unit testing, regression testing. Test driven design. Expectations and assertions. Mocking. Build-and-test servers. Negative testing. Sensible error messages. Managed logging. Debugging and debuggers. Coverage measurement.
    
  3.   Best practice in construction. Comments. Coding conventions. Documentation. Refactoring. IDEs. Configuration files. Using libraries.
    
  4.   Design and development. Object oriented design. Software as engineering. Pragmatic use of diagram languages. Requirements engineering. Agile and Waterfall. Functional and architectural design.
    
  5.   Building and deployment. Build tools. CMake and Scons.
       Engineering for portability. Packaging. Deploying.
    

Prerequisites: You must have reasonable experience in at least one compiled language, such as C++, C, or Fortran, and at least one dynamic language, such as Python, Ruby, Matlab or R. You must also have experience of the Unix shell.

Examples and exercises for this course will be provided in C++ and Python. You will therefore find it easiest to follow along if you have experience in at least one of these languages. Appropriate Python experience could be obtained from the Software Carpentry Bootcamp, while C++ experience can be obtained from the RITS C++ course. Previous experience with version control (such as from Software Carpentry) would be helpful.

You are required to bring your own laptop to the course as the classrooms we are using do not have desktop computers.