Workflow
| Resource Type | Link / Command |
|---|---|
| 📄 Documentation | Workflow Documentation |
The SoFAIR workflow (Figure 1) shows how stakeholders, tools and infrastructures work together. We provide brief description of each step and the resources available to perform it.
Figure 1: The SoFAIR workflow
- An author deposits a piece of research software in a code repository.
- The author then deposits a manuscript that contains either explicit or implicit mentions of that software.
- The research paper is then harvested from the repository by CORE and software mentions extracted from the full text research paper using extended state-of-the-art ML tools (GROBID / Softcite (Lopez, et al., 2021)).
| Resource Type | Link / Command |
|---|---|
| 📄 Documentation | New pipeline for software mention extraction... |
| 🤗 Models | HuggingFace Collection |
| 🐳 Docker Image | docker pull lfoppiano/software-mentions:0.8.2-sofair |
| 💻 Service Code | GitHub: softcite/software-mentions |
| 💻 Filter Tool | GitHub: SoFairOA/filter |
- Via the CORE Repository Dashboard, a request to validate the extracted mentions is made available to the repository.
- With the authorisation of the repository manager, the request is routed to the author (e.g. by means of an email notification) who validates this request.
| Resource Type | Link / Command |
|---|---|
| 💻 Code | Validation Form |
- Once validated, the repository issues an asset registration request to Software Heritage.
- Software Heritage permanently archives the new software asset.
- Software Heritage issues a permanent identifier for the new asset and sends this back to the repository.
For the full details on the workflow and the interactions between the various infrastructure component please follow the Workflow documentation at the link in the table above.