Skip to main content Site map
HomeResource hub

Choosing project and product names

Bookmark this page Bookmarked

Choosing project and product names

Author(s)
Simon Hettrick

Simon Hettrick

Director of Strategy

Mike Jackson

Estimated read time: 13 min
Sections in this article
Share on blog/article:
LinkedIn

Choosing project and product names

Your new project (or software or product or anything) needs a name. Welcome to hours of head scratching, playing with acronyms, mashing words into unnatural forms and asking your friends and family ‘what does GreatWare say to you?’ Now imagine spending the next few years of your life on the project only to find that someone else is using the same name – and they used it first. When starting a project, checking that the name you’ve chosen is unique feels like an extra, unwanted headache, but it is well worth the effort.

Share on blog/article:
LinkedIn
HomeResource hub

Software development: general best practice

Bookmark this page Bookmarked

Software development: general best practice

Author(s)

Mike Jackson

Estimated read time: 5 min
Sections in this article
Share on blog/article:
LinkedIn

Software development: general best practice

You will find that development of new code and maintenance of existing code is easier if you adopt best practices that have evolved over many years. Exactly how these practices should be implemented will depend on the nature of your project. If you would like help with best practice, the Software Sustainability Institute can advise you on how to proceed.

In general, there are two guiding principles to keep in mind when approaching a new software development project:

  • Be aware of your goal
  • Be prepared for change
Share on blog/article:
LinkedIn
HomeResource hub

Writing readable source code

Bookmark this page Bookmarked

Writing readable source code

Author(s)

Mike Jackson

Estimated read time: 11 min
Sections in this article
Share on blog/article:
LinkedIn

Writing readable source code

Readable source code is vital

If our peers are to quickly and easily understand our source code, it must be readable. The Software Sustainability Institute can provide advice and guidance on producing readable source code. We can even review your source code to see whether it can be improved.

Share on blog/article:
LinkedIn
HomeResource hub

How to frustrate your users, annoy other developers and please lawyers

Bookmark this page Bookmarked

How to frustrate your users, annoy other developers and please lawyers

Author(s)

Mike Jackson

Estimated read time: 7 min
Sections in this article
Share on blog/article:
LinkedIn

How to frustrate your users, annoy other developers and please lawyers

When writing software, you’re writing something that others will use. And in these days of off-the-shelf components, you may be using or bundling other peoples’ software too. This handy guide describes some simple, yet proven, ways in which you can successfully make the life of your users an absolute misery, incur the wrath of your fellow developers and make software lawyers salivate.

Share on blog/article:
LinkedIn
HomeResource hub

Best practice for funding the use of cloud in research

Bookmark this page Bookmarked

Best practice for funding the use of cloud in research

Author(s)
Neil Chue Hong

Neil Chue Hong

Director

Mike Jackson

Estimated read time: 17 min
Sections in this article
Share on blog/article:
LinkedIn

Best practice for funding the use of cloud in research

This guide provides best practice, guidance and recommendations to funders of research projects that potentially involve the use of cloud computing. It may also be of interest to senior managers and research directors. An understanding of the potential benefits of cloud computing and the issues arising from its use can contribute towards a more effective exploitation of cloud computing within research, particularly as the community seeks to clarify its strategic plan for the UK Research Computing Ecosystem.

This guide is intended to help answer a range of questions, such as:

  • If a researcher or institution requests money for cloud computing resources, what issues should I bear in mind as a programme manager?
  • If a researcher or institution asks for funding for hardware, how should I assess this request to provision new infrastructure?
  • What do I need to consider if investigating the provisioning of a shared cloud computing infrastructure that can be made available to researchers across a range of institutions?
Share on blog/article:
LinkedIn
HomeResource hub

Developing scientific applications using a Model-View-Controller approach

Bookmark this page Bookmarked

Developing scientific applications using a Model-View-Controller approach

Author(s)
Steve Crouch

Steve Crouch

Software Team Lead

Estimated read time: 8 min
Sections in this article
Share on blog/article:
LinkedIn

Developing scientific applications using a Model-View-Controller approach

Many scientific codes in research are developed in an organic way: you need a feature, so you code a feature. Perhaps it is a command line program that now needs to process the input data differently and output result data to a file in a different format. So for convenience, you code the extension in a single location in your program. It works, you understand it (and others can understand it!), and it is well tested. It's good, right? Maybe. But let's take a more thorough look...

Share on blog/article:
LinkedIn
HomeResource hub

Digital preservation and curation - the danger of overlooking software

Bookmark this page Bookmarked

Digital preservation and curation - the danger of overlooking software

Author(s)
Simon Hettrick

Simon Hettrick

Director of Strategy

Estimated read time: 6 min
Sections in this article
Share on blog/article:
LinkedIn

Digital preservation and curation - the danger of overlooking software

From preserving research results, to storing photos for the benefit of future generations, the importance of preserving data is gaining widespread acceptance. But what about software?

It’s easy to focus on the preservation of data and other digital objects, like images and music samples, because they are generally seen as end products. The software that is needed to access the preserved data is frequently overlooked in the preservation process. But without the right software, it could be impossible to access the preserved data - which undermines the reason for storing the data in the first place.  

This guide is targeted at people who are responsible for preserving data and digital objects on behalf of others. These people typically work for libraries, museums and archives.

Our goal in this guide is to explain why long-term software preservation is necessary, what needs to be understood before software can be preserved and how to get started with the preservation process

Share on blog/article:
LinkedIn
HomeResource hub

Ready for release?

Bookmark this page Bookmarked

Ready for release?

Author(s)

Mike Jackson

Estimated read time: 13 min
Sections in this article
Share on blog/article:
LinkedIn

Ready for release?

A checklist for developers

To get people using your software as quickly and painlessly as possible, you should invest a little of your time preparing everything your users will need before you release your software. This guide describes some simple things you can do to improve your users' experience of your software.

Share on blog/article:
LinkedIn
HomeResource hub

How to make your script ready for publication

Bookmark this page Bookmarked

How to make your script ready for publication

Author(s)

Carina Haupt

Estimated read time: 4 min
Sections in this article
Share on blog/article:
LinkedIn

How to make your script ready for publication

By Tobias Schlauch, Carina Haupt and the software engineering group at the German Aerospace Centre. 

This guide is part of the Research Software Camp: research accessibility web content series. 

Based on the "Sustainable Software Development for Researchers" alias "Bring Your Own Script and Make It Ready for Publication" workshop, this guide is a short overview about the steps recommended to make your code sustainable, enabling others to use and modify it. 

Share on blog/article:
LinkedIn
HomeResource hub

A Guide on Recording Screencasts, Online Training and Events and Live Streaming

Bookmark this page Bookmarked

A Guide on Recording Screencasts, Online Training and Events and Live Streaming

Author(s)
Aleksandra Nenadic

Aleksandra Nenadic

Training Team Lead

Neil Chue Hong

Neil Chue Hong

Director

Simon Hettrick

Simon Hettrick

Director of Strategy

Mario Antonioletti

Mario Antonioletti

Community Officer / Research Software Engineer

Rachael Ainsworth

Rachael Ainsworth

SSI fellow

Graeme Smith

Graeme Smith

Events Coordinator

Estimated read time: 15 min
Sections in this article
Share on blog/article:
LinkedIn

A Guide on Recording Screencasts, Online Training and Events and Live Streaming

Depending on the type of recording you are going to do, the amount of post-processing expected and your technical knowledge about video recordings, you will have to plan which recording tool(s) to use, any permissions from the people that are going to be in your recording, where you are going to store your recording (video files tend to be very big), and how you are going to publish and share your recordings. You will also need sufficiently powerful hardware at your disposal to process the recording, along with sufficient disk space to store the original recording and any derived output. As always, make sure you keep the original video in case you make a mistake and have to go back (do not overwrite it) and save your derived output often in case the application crashes.

Share on blog/article:
LinkedIn
Subscribe to Researcher
Back to Top Button Back to top