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

RSETraining2019 Test #43

Merged
merged 88 commits into from
Apr 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
c2e74ee
initial changes
n-romanova Jan 7, 2020
f7b47d3
Update index.mdx
n-romanova Jan 7, 2020
4e2dff6
More commits
n-romanova Jan 22, 2020
878320c
Added About Page
n-romanova Jan 22, 2020
44e4770
Update session01 .mdx
n-romanova Jan 23, 2020
96df003
more commits
n-romanova Jan 24, 2020
2c0c2f6
Edited sessions 3-7
n-romanova Jan 29, 2020
752e691
Merge pull request #1 from DARIAH-ERIC/master
n-romanova Jan 31, 2020
60c810a
Some more commits
n-romanova Jan 31, 2020
8bd7b8c
Merge branch 'master' of https://github.com/n-romanova/dariah-campus
n-romanova Jan 31, 2020
03260b9
More commits
n-romanova Feb 4, 2020
5eb2a5f
More commits
n-romanova Feb 5, 2020
cfe9869
Some more commits
n-romanova Feb 6, 2020
f07541f
Changed colon
n-romanova Feb 12, 2020
06ac3bc
removed colon
n-romanova Feb 12, 2020
f28a1fd
Update index.mdx
n-romanova Feb 12, 2020
4e91056
Update index.mdx
n-romanova Feb 12, 2020
861defd
More changes
n-romanova Feb 12, 2020
9428fd4
more changes
n-romanova Feb 12, 2020
9f02d3c
Update session01.mdx
n-romanova Feb 12, 2020
680f258
More commits
n-romanova Feb 12, 2020
c43ff9d
Update session03.mdx
n-romanova Feb 12, 2020
b595c8e
Update session04.mdx
n-romanova Feb 12, 2020
497ace5
Update session05.mdx
n-romanova Feb 12, 2020
59c75d8
Update session01.mdx
n-romanova Feb 12, 2020
599f756
Merge pull request #2 from DARIAH-ERIC/master
n-romanova Mar 2, 2020
7f1ea00
More commits
n-romanova Mar 2, 2020
5a77766
Update session02.mdx
n-romanova Mar 2, 2020
8e38c7e
Update session03.mdx
n-romanova Mar 2, 2020
7b3270a
Update session04.mdx
n-romanova Mar 2, 2020
a4400da
Update session05.mdx
n-romanova Mar 2, 2020
9cd3035
Update session06.mdx
n-romanova Mar 2, 2020
e931143
Update session07.mdx
n-romanova Mar 2, 2020
6a21691
Update session08.mdx
n-romanova Mar 2, 2020
5c2e4e1
More commits
n-romanova Mar 2, 2020
d8cb3cd
Update session09.mdx
n-romanova Mar 2, 2020
d702380
Update session10.mdx
n-romanova Mar 2, 2020
d0a0625
More commits
n-romanova Mar 2, 2020
54bd729
Typo corrected
n-romanova Mar 2, 2020
1e6ebda
Update index.mdx
n-romanova Mar 2, 2020
a95f635
Update index.mdx
n-romanova Mar 2, 2020
87fd42a
Update index.mdx
n-romanova Mar 2, 2020
acedf01
Update index.mdx
n-romanova Mar 2, 2020
58276f1
Update index.mdx
n-romanova Mar 2, 2020
7f288dc
Update index.mdx
n-romanova Mar 2, 2020
a14ce0c
Update index.mdx
n-romanova Mar 2, 2020
92575d6
Update index.mdx
n-romanova Mar 2, 2020
4509fdf
Update index.mdx
n-romanova Mar 2, 2020
a391c75
Update index.mdx
n-romanova Mar 2, 2020
9c67d3e
Update session01.mdx
n-romanova Mar 2, 2020
4cb17ed
Update session01.mdx
n-romanova Mar 2, 2020
f1843ed
Update session01.mdx
n-romanova Mar 2, 2020
5747548
Update session01.mdx
n-romanova Mar 2, 2020
3f2be17
Update session01.mdx
n-romanova Mar 2, 2020
e52f287
Update session01.mdx
n-romanova Mar 2, 2020
20774ac
Update session01.mdx
n-romanova Mar 2, 2020
3a78c50
Update session01.mdx
n-romanova Mar 2, 2020
afb3394
Update session02.mdx
n-romanova Mar 2, 2020
99e9106
Update session02.mdx
n-romanova Mar 2, 2020
93bfbde
Changes to sessions 2-3
n-romanova Mar 2, 2020
ba756cd
Update session04.mdx
n-romanova Mar 2, 2020
0a71d66
Update session04.mdx
n-romanova Mar 2, 2020
b9f2840
Update session04.mdx
n-romanova Mar 2, 2020
b3cdbcd
Update session05.mdx
n-romanova Mar 2, 2020
64dd32c
More commits
n-romanova Mar 2, 2020
38fdc78
More commits
n-romanova Mar 2, 2020
a89ee1d
Update session10.mdx
n-romanova Mar 2, 2020
684f11b
Update session10.mdx
n-romanova Mar 2, 2020
ab0174f
More commits
n-romanova Mar 2, 2020
7454076
More commits
n-romanova Mar 2, 2020
2646300
Update session10.mdx
n-romanova Mar 2, 2020
b295c5e
More commits
n-romanova Mar 2, 2020
48b4083
more commits
n-romanova Mar 2, 2020
de87eb8
more commits
n-romanova Mar 2, 2020
9b72b89
test a01
n-romanova Mar 2, 2020
1e26611
revert
n-romanova Mar 2, 2020
0f34f8b
Test with end tags off
n-romanova Mar 2, 2020
29845d4
closed speaker tags
ttasovac Mar 7, 2020
ab2cac5
Update session04.mdx
ttasovac Mar 7, 2020
c369e24
Update Bibliography.mdx
ttasovac Mar 7, 2020
1d6c4b6
Merge pull request #3 from DARIAH-ERIC/master
n-romanova Mar 9, 2020
9c601ad
fix: use deps from master
stefanprobst Mar 10, 2020
a82c11e
various content fixes + ordered lists styling
ttasovac Apr 3, 2020
bba98b1
Update about.mdx
ttasovac Apr 3, 2020
e1f60bc
Proofing RSE Workshop
VickyGarnett Apr 7, 2020
14b9188
edited teaser + fixed ordered list css
ttasovac Apr 9, 2020
3b9c69e
remove three columns in popin lists
ttasovac Apr 9, 2020
70fe860
moved bibliography to about popup
ttasovac Apr 9, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions contents/data/person.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,35 @@
email: marjorie.burghart@gmail.com
website: http://marjorie.burghart.online.fr/?q=en

- name: Samantha Callaghan
slug: samantha-callaghan
avatar: ../images/authors/samantha-callaghan.jpg
website: https://www.kdl.kcl.ac.uk/who-we-are/samantha-callaghan/
description:
Samantha Callaghan is a Research Software Engineering Project Manager as
well as the Georgian Papers Programme Metadata Analyst. As an RSE Project
Manager, Samantha guides projects through KDL’s Software Development Life
Cycle. She also undertakes analysis, decommissioning documentation and
outreach work, particularly in relation to Indigenous DH and decolonising
practice in the GLAM sector.

- name: Angeliki Chrysanthi
slug: angeliki-chrysanthi
avatar: ../images/authors/angeliki-chrysanthi.jpg

- name: Arianna Ciula
slug: arianna-ciula
avatar: ../images/authors/arianna-ciula.jpg
description:
Dr Arianna Ciula is Senior Software Analyst and Deputy Director of King's
Digital Lab. Dr Ciula has broad experience in digital humanities research
and teaching, research management, and digital research infrastructures. She
holds a PhD in Manuscript and Book Studies (digital palaeography, University
of Siena), an MA in Applied Computing in the Humanities (King’s College
London) and a BA Hons in Communication sciences (computational linguistics,
University of Siena).
website: https://www.kdl.kcl.ac.uk/who-we-are/dr-arianna-ciula/

- name: Claire Clivaz
slug: claire-clivaz
avatar: ../images/authors/claire-clivaz.jpg
Expand Down Expand Up @@ -107,6 +132,17 @@
slug: marianne-huang
avatar: ../images/authors/marianne-huang.jpg

- name: Neil Jakeman
slug: neil-jakeman
avatar: ../images/authors/neil-jakeman.jpg
website: https://www.kdl.kcl.ac.uk/who-we-are/neil-jakeman/
description:
Neil Jakeman is Senior Software Analyst at King's Digital Lab. Neil has a
background in environmental analysis, spatial statistics and experience in
commercial development. At KDL, Neil has led the development of a number of
important projects. His particular teresearch interests lie in the fields of
geospatial humanities and virtual reality.

- name: Klaus Illmayer
slug: klaus-illmayer
avatar: ../images/authors/klaus-illmayer.jpg
Expand Down Expand Up @@ -252,6 +288,19 @@
- name: Rebecca Seirig
slug: rebecca-seirig

- name: James Smithies
slug: james-smithies
avatar: ../images/authors/james-smithies.jpg
website: https://jamessmithies.org/
description:
Dr James Smithies is Director of King’s Digital Lab. He was previously
Senior Lecturer in Digital Humanities and Associate Director of the UC
CEISMIC Digital Archive at the University of Canterbury, New Zealand. He has
worked in the government and commercial IT sectors as a technical writer and
editor, business analyst, and project manager. His monograph _The Digital
Humanities and the Digital Modern_ was published by Palgrave Macmillan in
2017.

- name: Juliane Stiller
slug: juliane-stiller
avatar: ../images/authors/juliane-stiller.jpg
Expand Down
7 changes: 7 additions & 0 deletions contents/data/tag.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@
their research outputs, which might include data, publications and training
activities, are available and open to all without restriction

- name: Project management
slug: project-management

- name: Research infrastructures
slug: research-infrastructures
description:
Expand Down Expand Up @@ -139,6 +142,10 @@
sciences and geography-based practices to study physical, cognitive,
perceptual and relational aspects of the human spatial experience

- name: Software development
slug: software-development
description:

- name: Speech technology
slug: speech-technology
description:
Expand Down
63 changes: 63 additions & 0 deletions contents/events/RSETraining2019/about.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# About

## [Partners](https://datacite.hypotheses.org/partners)

'MaDiH: Research Software Engineering (RSE) Training workshop inaugurated Phase
1 of
[Mapping the Digital Heritage in Jordan project](https://gtr.ukri.org/projects?ref=AH%2FS011722%2F1)
(MaDiH)'. This event was held with the guidance of:

- [Dr Andrea Zerbini](https://eamena.arch.ox.ac.uk/team/dr-andrea-zerbini/)

## Participants

- **Dr Fadi Bala'awi**, MaDiH Project PI, Dean of Queen Rania Faculty of Tourism
and Heritage, Hashemite University, Jordan
- **Arianna Ciula**, Senior Research Software Analyst and Deputy Director,
King's Digital Lab, King's College London, UK
- **Dr Stuart Dunn**, Head of Department of Digital Humanities, King's College
London, UK
- **Dr Alessandra Esposito**, MaDiH Project Research Associate, King's Digital
Lab, King's College London, UK
- **Dr Adrian Evans**, MaDiH Consultant, Research Fellow, School of
Archaeological and Forensic Sciences, University of Bradford, UK
- **Dr Pascal Flohr**, Researcher on the Endangered Archaeology in the Middle
East and North Africa (EAMENA) project, Oxford University, UK
- **Sahar Idwan**, Dean of Information Technology, Hashemite University, Jordan
- **Neil Jakeman**, Senior Research Software Analyst, King's Digital Lab, King's
College London, UK
- **Samia Khouri**, Department of Antiquities, Director of Museums, Jordan
- **Issa Mahasneh**, Executive Director of the Jordanian Open Source
Association, Jordan
- **Shatha Mubaideen**, MaDiH Project Manager, University of Jordan, Jordan
- **Dominic Oldman**, Head of ResearchSpace, The British Museum, UK
- **Dr Carol Palmer**, Director of the Council for British Research in the
Levant (CBRL), UK
- **Professor Shaher Rababeh**, MaDiH Project Co-I, Vice President, Hashemite
University, Jordan
- **Raya Sharbain**, Jordan Open Source Association, Jordan
- **Dr James Smithies**, MaDiH Project PI, Director, King's Digital Lab, King's
College London, UK
- **Tom Sparrow**, Research Fellow, School of Archaeological and Forensic
Sciences, University of Bradford, UK
- **Diana Tanase**, Senior Curator of ResearchSpace, The British Museum, UK
- **Dr Will Wootton**, Senior Lecturer, Department of Classics, King's College
London

## Coordination

**Arianna Ciula**, King's Digital Lab, King's College London, UK

## Companion blog

[https://www.kdl.kcl.ac.uk/blog/](https://www.kdl.kcl.ac.uk/blog/madih-research-software-engineering-rse-training-london/)

## Bibliography

The complete list of websites and publications mentioned in the sessions' slides
can be found in
[KDL RSE Training 2019 Zotero Bibliography](https://www.zotero.org/groups/2345477/kdl_rse_training/library).

## Contact

Arianna Ciula, King's Digital Lab: arianna.ciula[AT]kcl[DOT]ac[DOT]uk
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions contents/events/RSETraining2019/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: 'MaDiH: Research Software Engineering Training'
slug: rse2019
type: event
date: 2020-04-09
categories:
- events
abstract:
Hosted by King’s Digital Lab (KDL) at King’s College London, the workshop
introduced participants to best practices in project management, the Agile
Dynamic System Development Methods (DSDM) as well as various theoretical and
practical approaches to digital cultural heritage.
authors:
- arianna-ciula
- james-smithies
logo: images/madih-logo.png
featuredImage: images/madih_background_darkened.jpg
tags:
- data-modeling
- software-development
- data-management
- project-management
license: CCBY 4.0
partners:
- dariah-eu
social:
- name: website
url: https://www.kdl.kcl.ac.uk/
- name: kdl-info@kcl.ac.uk
url:
- name: flickr
url: #add url for pictures
- name: twitter
url: https://twitter.com/kingsdigitallab
synthesis: docs/doc-name.pdf
#if you created a summary or report on the activities at the event, you can include it here as a .pdf.
---

# 'MaDiH: Research Software Engineering Training'

## An Open Access synthesis of the RSE Training workshop for MaDiH project, King's Digital Lab, London 2-5 July 2019

The purpose of the workshop was to introduce best practices in Research Software
Engineering and the Software Engineering Lifecycle (SDLC) adopted at King's
Digital Lab. The target audience of the workshop was members of the team of the
AHRC-funded "MaDiH: Mapping the Digital Cultural Heritage in Jordan".
45 changes: 45 additions & 0 deletions contents/events/RSETraining2019/session01.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
number: 1
title: "King's Digital Lab: Overview and Context"
speakers:
- james-smithies
---

## Welcoming remarks

### Professor Graeme Earl

The participants were welcomed by the Vice-Dean for External Relations at
[King's College London](https://www.kcl.ac.uk/),
[Professor Graeme Earl](https://www.kcl.ac.uk/people/professor-graeme-earl) from
the [Department of Digital Humanities](https://www.kcl.ac.uk/ddh)

## Abstract

_King's Digital Lab: Overview and Context_

The session gave an overview of the institutional context of the workshop,
mentioning over 30 years of history of Humanities Computing and Digital
Humanities (DH) at King’s College London and presented King’s Digital Lab (KDL),
founded in 2015; KDL’s place and role within the university, its team,
infrastructure, activities, projects, funding strategy, partners and
collaborators were briefly discussed. The session dwelled on emerging as well as
core research themes and directions for KDL, such as immersive experiences,
software development, archiving and sustainability, machine learning and big
data analysis, design, visualisation and indigenous DH. The last part of the
session focused on the contexts in which KDL operates that necessitate a balance
between a drive for innovation and focus on continuity and value, between
experimentation and institutional responsibility. In order to address the scale
and complexity of contemporary DH projects and infrastructures, KDL has adopted
and adapted industry standards, broadly accepted research data management
workflows and clearly defined processes for documentation and software
development lifecycle (SDLC).

<Download download="docs/1.1-Intro_KDL.pdf" />
<Speakers>

<Speaker speaker="james-smithies">

</Speaker>

</Speakers>
45 changes: 45 additions & 0 deletions contents/events/RSETraining2019/session02.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
number: 2
title: 'KDL Practices: Team, Systems, Data and Models (Part One)'
speakers:
- arianna-ciula
---

## Abstract

The first part of the session began with the description of team roles at KDL,
aligned with a holistic vision of Research Software Engineering (RSE) career
paths plotted in a continuum from research active to research support profiles,
mappable to best practices in industry standards such as development and
management frameworks (in particular the Agile Dynamic Systems Development
Method: DSDM) and competence skills (e.g. SFIA). These roles and promotion
processes were compared and contrasted with traditional roles and promotion
processes in academia on the one hand, and industry on the other. Focusing on
the example of the analyst role, the range of tasks and responsibilities
inherent to the role was demonstrated.

In what followed, infrastructures and frameworks used at KDL, the lifecycle of a
typical project and its SDLC were outlined, beginning with initial contact by
the partner (i.e. an academic, a research institution or a business) through to
funding application, release and post-project hosting and maintenance. Sources
of funding and classification of projects according to size were also discussed.

KDL members of staff work on several projects in different stages of development
at the same time, and in order to manage the workflow most effectively, the team
has implemented flexible “timebox planning”, whereby tasks are planned for each
“timebox” (two-week period) and then are revised according to priority and
resources. In order to manage and document the processes effectively, KDL has
developed a set of templates for project governance documentation corresponding
to each stage of the project SDLC (such as “Terms of Reference”, “Feasibility”,
“Product Quote”, “Project Review Record” and “Service Level Agreement (SLA))”.
Simplified templates with contextual information on use can be consulted by
accessing KDL’s repository on GitHub.

<Download download="docs/1.2-Practices_1.pdf" />
<Speakers>

<Speaker speaker="arianna-ciula">

</Speaker>

</Speakers>
39 changes: 39 additions & 0 deletions contents/events/RSETraining2019/session03.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
number: 3
title: 'KDL Practices: Team, Systems, Data and Models (Part Two)'
speakers:
- arianna-ciula
---

## Abstract

The second part of the session introduced the concept of “Double Diamond” – a
visual map of the design process (developed and described by the
[Design Council](https://www.designcouncil.org.uk/news-opinion/what-framework-innovation-design-councils-evolved-double-diamond)).
The Double Diamond model posits the necessity, for any creative process, to
spend time defining the problem before setting out to solve it. Therefore, the
process is divided into four distinct phases – Discover (a problem), Define (the
problem), Develop (a solution) and Deliver (the solution).

These four phases can be mapped onto two of the three stages of KDL’s workflow
which comprises

1. Pre-project (Discover/Define)
2. Project development from start to launch (Define, Design and Develop)
3. Post project (maintenance, archiving and decommission)

The second phase of project evolutionary development is an iterative cycle that
evolves as development progresses.

The rest of the session was dedicated to detailed analysis of workflows by RSE
role (Project Manager; Analyst; Software Engineer; UI/UX Designer; Systems
Manager) with the tasks mapped onto the three stages of KDL project workflow,
from Pre-project through Project development to Post-project.

<Download download="docs/1.3-Practices_2.pdf" />
<Speakers>

<Speaker speaker="arianna-ciula">

</Speaker>
</Speakers>
57 changes: 57 additions & 0 deletions contents/events/RSETraining2019/session04.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
number: 4
title: Project Requirements
speakers:
- arianna-ciula
---

## Abstract

At the beginning of the session, the elements to be taken into consideration
while planning any DH project were named and discussed: a **core** idea
typically evolves into a set of **research** questions, then **methods** to
address them are identified along with **management** approaches, required
**budget** to support the project and any **sustainability** issues that need to
be planned for in advance.

When it comes to development, in contrast to traditional project management
approaches that fix the features to be implemented in the course of the project,
Agile project management approaches, adopted by KDL, treat time and cost as
fixed variables. Instead of committing to implementing a set of features, the
team commits to delivering value within defined constraints of cost and time,
whereas features may change as the project progresses.

At pre-project stage, feasibility analysis needs to be conducted before a
project is considered viable and the rest of the life-cycle initiated. In order
to prioritise requirements, KDL uses a prioritisation technique known as the
MoSCoW principles, whereby, following consultation with the partners, each
required feature is assigned a status: M for “must”, S for “should”, C for
“could” and W for “will not have this time”. W requirements, although recorded
by the analyst, are considered to be outside the scope of the project, and C
requirements are low priority. In the iterative process of project development,
this prioritisation technique is used throughout the project at review meetings.

Since this training workshop was part of a specific project ("MaDiH: Mapping
Digital Cultural Heritage in Jordan") with a defined core idea and a set of high
level requirements, the rest of the session focused on the project deliverables.
Producing a Proof of Concept (PoC) is one of the objectives of the project; the
notion of prototype, proving that a scaled-up version of the project can be
executed, was therefore discussed and critiqued as RSE best practice to
encourage review of and reflection on the project’s feasibility and gap
analysis.

The session further provided some examples taken from the MaDiH pre-project
stage and demonstrated KDL’s template for requirement analysis.

In addition, the applications of the “Comprehensive Archive Network” (CKAN)
system, widely used across the public sector, as a proposed solution for
capturing metadata in MaDiH was discussed as an example of how an RSE solution
evolves through the KDL software development lifecycle.

<Download download="docs/2.1-Requirements.pdf" />

<Speakers>

<Speaker speaker="arianna-ciula"></Speaker>

</Speakers>
Loading