Why?

Research Software

powers research

across all

domains!

Image attribution:
European Southern Observatory (ESO) - CC BY 4.0; Juan Carlos Fernandez Diaz/National Center for Airborne Laser Mapping;
The European Environment State and Outlook 2015; Fusion Medical Animation - Unsplash License;

Crucial, Yet Invisible

UNESCO recommends FOSS for open science
Funding agencies will require it more and more
Studies highlight importance of Research Software, but attention is limited

Reproducibility and Replicability

How?

SMP Tool

smp.research.software

## Example Analysis Script

- Simple software
                - Simple SMP

<div class="fragment" style="padding-top: 1em;">
                Watch and enjoy
                </div>

Note:
                ### SMP answers for Tree-house detector:
                - Name & Purpose
                    - tree_house_detector  # python import-ready name: lower case, underscores
                    - A script to detect the presence of trees in pictures of houses for sale
                -  Software Access
                    - Yes
                - Reuse/Reproduce
                    - No  (show decision help)
                - Authors
                    - Sander van Rijn, s.vanrijn@esciencecenter.nl
                    - Ole Mussmann, o.mussmann@esciencecenter.nl
                - Ownership
                    - Netherlands eScience Center
                - Context
                    - My NWO project (TODO: find NWO project code)
                - Citation
                    - Example citation is at the bottom of the README
                - Versioning
                    - Calendar versioning
                    - Git
                    - Will upload to GitHub
                - License
                    - MIT
                - Documentation
                    - Example usage will be in the README
                    - Installation command using requirements.txt will be in the README
                - Risks
                    - No personal data, or generative AI
                - DMP
                    - Uses data, see DMP: https://link.to.dmp.com

## Spine-Toolbox

- Complex software suite
                - Extensive SMP

<div class="fragment" style="padding-top: 1em;">
                Follow along and fill in your own, at<br>
                <a href="https://smp.research.software">smp.research.software</a>!
                </div>

Note:
                ### SMP tool example answers
                - Name & Purpose
                    - spine_toolbox  # python import-ready name: lower case, underscores
                    - Spine Toolbox is an open source Python package to manage data, scenarios and workflows for modelling and simulation. You can have your local workflow, but work as a team through version control and SQL databases.
                - Scope
                    - yes, yes, yes, yes
                - Authors
                    - Juha Kiviluoma
                      juha@email.com
                - Ownership
                    - Mopo Project - https://www.tools-for-energy-system-modelling.org
                - Context
                    - Call: HORIZON-CL5-2022-D3-01
                      Proposal number: 101095998
                - Citation
                    - Attribution text in README.md file
                      We should consider having a CITATION.cff file
                - Versioning
                    - SemVer
                    - Git
                    - Public repo on GitHub: https://github.com/spine-tools/Spine-Toolbox
                - License
                    - GPL 3.0
                - Documentation
                    - User documentation: https://spine-toolbox.readthedocs.io/en/latest/
                    - There's a brief section in README.md for devs and a more extensive "developer documentation" and "contributing guide" in the user documentation (see above).
                      We could have better developer documentation in *one* place.
                    - Installation instructions in README.md. Could be more detailed.
                - Maintenance
                    - The VTT Technical Research Centre of Finland maintains the software in the long run, we should document this somewhere.
                - Sustainability
                    - We will apply for additional rounds of funding to ensure further development. In the meantime, commercial partners use and work on the project as well.
                - Support
                    - We support users via email and GitHub issues. During the project we allocate time for dissemination and workshops. After the project ends, this will continue on a best-effort basis.
                - Quality
                    - We don't have one yet.
                    - We use pytest and have GitHub runners test the whole software suite whenever we push code. All tests are in the `/tests` folder.
                - Packaging
                    - Releases are automatically packaged and published at https://pypi.org/project/spinetoolbox/ and can be pip-installed.
                - Risk Analysis
                    - We don't use sensitive data ourselves. Security risks can be communicated via email or GitHub issues. We have no policy around using LLM generated code.
                - Data Management Plan
                    - We have no data of our own and thus no DMP.

language	esciencecenter.nl
mail_outline	info@esciencecenter.nl
phone	+31 (0)20 460 4770