Principles
The principles that guide pattern classification and architectural decisions across the RSE Capacity Enhancement Project.
FAIR (data)
Wilkinson et al. 2016, Scientific Data
Principles governing the stewardship of data and metadata: its findability, accessibility, interoperability, and reuse.
- Findable
Data and metadata should be easy to find for both humans and computers. Machine-readable metadata is essential for automatic discovery.
- Accessible
Once found, data and metadata should be retrievable via standardised, open protocols with clear authentication and authorisation where needed.
- Interoperable
Data should use shared vocabularies and formats so it can be combined with other data and work with applications or workflows for analysis, storage, and processing.
- Reusable
Data and metadata should be richly described with accurate provenance so they can be replicated and/or combined in different settings.
FAIR for Research Software
Chue Hong et al. 2022, Scientific Data
Principles governing research software across its whole lifecycle: how it is identified, run, depended on, licensed, and reused.
- Findable
Software and its metadata are easy for humans and machines to find, with a persistent identifier and distinct identifiers for components and different versions.
- Accessible
Software is retrievable by its identifier over open protocols, and its metadata stays accessible even when the software itself no longer is.
- Interoperable
Software reads, writes, and exchanges data using domain-relevant community standards, and includes qualified references to other objects.
- Reusable
Software is both usable (can be executed) and reusable (can be understood, modified, built upon), with a clear licence, detailed provenance, and qualified references to other software.
Project tenets (HASS RSE)
Traceable to RSE-CEP co-design evidence
Project values that guide architectural and design decisions in HASS and Indigenous research software engineering.
- Minimal sustained infrastructure
Prefer architectures that minimise what must be maintained, funded, secured, and migrated over time. Running infrastructure must earn its keep against the cost of sustaining it.
- Complexity earns its keep
Default to the simplest thing that works. Added abstraction or surface area must be justified by a clear benefit that outweighs the ongoing cost of understanding and maintaining it.
- Attested usage
Favour tools and approaches with a demonstrable track record over novelty. Evidence of sustained use in comparable contexts reduces risk for communities with limited technical capacity.