Ep. 4: Documentation for Research Code

[jyoti-bhogal]

List of tasks for the linked posts for Ep 4:
⁠ ⁠

• create events page on website
• First LI post of registration open using flyer
• ⁠second LI post with updates of speakers
• first post on OLS about with speaker names
• ⁠third LI post with updated website
• Post blog from ep 3 on the RSE Asia website and RSE Asia LI
• ⁠fourth LI post for 10 days left to register
• second post on OLS about 10 days left to register
• 5 days left to register
• 1 day left to register
• plus cross-post on OLS and RSE slack

[jyoti-bhogal]

Do you feel that writing documentation for the code you develop as part of your research projects is a humungous task?

This month we will focus on the importance of documentation for code and how to achieve it in simple ways.

Come meet our speakers as we engage in a conversation with them online!

• Jenny Wong, Technical Content Developer, 2i2c (US-based organisation)
• Joel Nitta, Associate Professor, Chiba University, Japan
• Mthetho Vuyo Sovara, Research Support Scientist, Centre for High-Performance Computing (CHPC), National Integrated Cyberinfrastructure System (NICIS), South Africa

What Will be Discussed?

• Motivation for creating documentation
• Different types of documentation
• Easy steps to create documentation, like in-code comments, README files, etc.
• Advanced documentation options

💻 Topic: Opening Up Research Code
🗓️ Date: 23 Jan 2025
⏰ Time: 8:30-10 UTC
🔗 Online, free (registration required), and open to all!

Registration is free and open to all!
Registration to start soon!

For more info, visit: https://rse-asia.github.io/RSE_Asia/events/2024-01-23_Ep-4-Documentation_For_Research_Code/

#RSEng

<Ep 4 flyer>

[jyoti-bhogal]

Post 2:

📢 Registrations are now open for the 4th episode of the series 'Enabling Open Science Through Research Code'!

Come meet our speakers as we engage in a conversation with them online!

• Jenny Wong, Technical Content Developer, 2i2c (US-based organisation)
• Joel Nitta, Associate Professor, Chiba University, Japan
• Mthetho Vuyo Sovara, Research Support Scientist, Centre for High-Performance Computing (CHPC), National Integrated Cyberinfrastructure System (NICIS), South Africa

💻 Topic: Documentation for Research Code
🗓️ Date: 23 Jan 2025
⏰ Time: 8:30-10 UTC
🔗 Online, free (registration required), and open to all!

Registration is free and open to all!
Register here: https://us06web.zoom.us/meeting/register/tZ0scOmspz0iH9IMt4yxc0O37uEUUiPxYDxa#/registration

For more info, visit: https://rse-asia.github.io/RSE_Asia/events/2024-01-23_Ep-4-Documentation_For_Research_Code/

#RSEng