Open carlosug opened 2 months ago
List of commonly identified instructions in the readme files. Part (col 1), Description (col 2), Section (col 3) and keywords to identify each section:
Part | Description | Method | Keywords |
---|---|---|---|
Pre-installation (requirements -NOT INCLUDED IF AUTHOR ADDED THESE IN DIFFERENT HEADER) | Preparation instructions before installation | 283 | prerequisite, environmental setup, requirements, dependency setup, operating system |
Installation | Instructions to obtain the source code and then execute a set of predefined operations to install the software locally | Source | install locally, from source, from Git, git clone , set up virtual environment, python3 -m venv , pip install module . |
Installation | Instructions to obtain the software via building and running container such as Docker image from the dockerfile within the source code | Container | from docker, singularity, docker compose-up |
Installation | from package management systems, such as Pip, Conda, and Maven, which enable an easier installation experience | Package Manager | from PiP, pip install |
Installation | other ways of installing software such download binaries | Alternate | downloading |
Optional | other settings needed for operational systems | **** | downloading |
Post-installation | Instructions to execute the software to perform specific tasks such as installation check and running test | 283 | c |
Help information | 301 | 283 | c |
External resources | 301 | 283 | c |
add bi and tri bigrams
List of all descriptors extracted for the datasets, including a brief description akin:
https://www.nature.com/articles/s41598-024-55742-x/tables/1