NoteThese standards promote and enable discovery and access for model code, documentation, and metadata. Comments and suggestions are welcomed, and will be carefully considered by the OMF Working Groups and Membership. The standards goals and minimum implementation standards aim to capture concerns and practices among the members of OMF. Individual application domains may extend these standards to capture additional context relevant to their domain.
Overview of Accessibility Standards
Goals for Accessibility Standards
- Humans can read the model source code
- Machines can read the model source code
- Models follow Accessibility standards from the emerging FAIR standards for research software (ongoing work at https://www.rd-alliance.org/groups/fair-research-software-fair4rs-wg)
- Models are available in findable, trusted digital repositories
- Citations lead to the exact version of a model used in the citing publication
- Models need to be published/archived in a trusted, FAIR-aligned, digital repository that exposes metadata publicly
Minimal Accessibility Standards
Model code and documentation should be archived in a searchable, open access, trusted digital repository. A DOI, permanent URL or other permanent digital resource locator for accessing the model code must be provided that links to the specific version of the code used. The archive should adhere to FORCE11 software citation principles ( https://www.force11.org/software-citation-principles) and expose their metadata in open, interoperable formats like schema.org or codemeta.
Ideal Accessibility Standards
- sponsors require model source code to be made publicly available in a trusted digital repository
- journals require model source code publicly available in a trusted digital repository
- model source code uses build and packaging tools that facilitate accessibility (examples: pipenv / pip / poetry in Python, ant / maven in Java, Makefiles)
- model source code has a Dockerfile or other containerization support so it can be run on multiple platforms
Cyberinfrastructure and Tools for Implementation of Accessibility Standards
Create a clear checklist for the OMF website and training purposes that facilitates good software development practices with transparency and openness from the start.
- Can you run your model on another computer/operating system?
- Is your model code readable to others e.g., clean code that is well structured with clear and self-documenting variable names, well-commented and documented procedures, algorithms, and assumptions
- Does your archived model live in a digital repository that follows FAIR principles for research software
- Can you run your model in 5 years (containerization helps but there are still open issues with dependencies on proprietary software)
Examples and References for Accessibility
- An initial list of digital repositories for software can be found at https://www.comses.net/resources/trusted-digital-repositories/ [perhaps this will become part of the OMF website?]
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.