Skip to content

Commit dd2f3fd

Browse files
updated the readme file
1 parent 1f72a10 commit dd2f3fd

1 file changed

Lines changed: 101 additions & 53 deletions

File tree

README.md

Lines changed: 101 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ This software extracts relevant data from SOMEF (Software Metadata Extraction Fr
66

77
## Table of Contents
88

9-
- [About the Software](#about-the-software)
10-
- [Research Questions](#research-questions)
11-
- [Installation](#installation)
12-
- [Usage](#usage)
13-
- [Output Format](#output-format)
9+
- [Metadata-Adoption-Quantify](#metadata-adoption-quantify)
10+
- [Table of Contents](#table-of-contents)
11+
- [About the Software](#about-the-software)
12+
- [Research Questions](#research-questions)
13+
- [Features](#features)
14+
- [Installation](#installation)
15+
- [Output](#output)
1416

1517
## About the Software
1618

17-
This tool is designed to process metadata extracted using SOMEF, focusing on answering predefined research questions. It parses the data from SOMEF's output and generates JSON files with the information relevant to each research question (RQ).
19+
This tool is designed to process metadata extracted using SOMEF, focusing on answering predefined research questions. It parses the data from SOMEF's output and generates JSON files with the information relevant to each research question (RQ) and generating calculations for each data requested.
1820

1921
## Research Questions
2022

@@ -51,15 +53,40 @@ You can extract SOMEF output (Already extracted) with:
5153
```bash
5254
python run_somef.py
5355
```
54-
In order to use, you can run every RQ individually with an example:
56+
In order to use, you can run every RQ individually using the `main.py`:
5557
5658
```bash
57-
python rq1.py
59+
python main.py
5860
```
61+
And it will prompt you the following:
5962
60-
## Output
63+
```bash
64+
=== Main Menu ===
65+
1. Run RQ scripts
66+
2. Calculate results
67+
exit. Quit
68+
Choose an option (1/2/exit):
69+
```
70+
If you choose 1. you will be able to choose which research question you wish to answer:
6171
62-
This is an output example of RQ1 from one cluster:
72+
```bash
73+
Available RQ scripts:
74+
1. rq1.py
75+
2. rq2.py
76+
3. rq3.py
77+
4. rq4.py
78+
5. rq5.py
79+
Enter RQ number (1-5) or 'back':
80+
```
81+
Once you choose an RQ, you will be prompted to put some input regarding the naming of the files, the directories etc... (You need to follow the same naming of the already existing files if you wish to use `count_results.py` to iterate through the results of analysis and calculate the final results, for example for rq1, you should name the output for envri `analysis_envri_rq1.json`, check the rest of the files to follow the naming convention)
82+
83+
If in the main menu you choose 2. you will be prompted to fill in the directory of the results, and the cluster you wish to calculate for:
84+
```bash
85+
Running results calculation...
86+
Input the research question (rq1, rq2, rq3, rq4, rq5) or type 'exit' to quit:
87+
```
88+
## Output
89+
If you choose to get the somef results of RQ1 and input the prompts accordingly, you get this result for RQ1 from one cluster (This is ESCAPE)
6390
```bash
6491
{
6592
"citation.cff": {
@@ -69,81 +96,102 @@ This is an output example of RQ1 from one cluster:
6996
"count": 17
7097
},
7198
"package": {
72-
"count": 13,
99+
"count": 7,
73100
"files": [
74-
"temp_analysis/escape2020\\cds-astro_aladin-lite\\aladin-lite-3.3.2\\package.json",
75-
"temp_analysis/escape2020\\cds-astro_aladin-lite\\aladin-lite-3.3.2\\src\\core\\Cargo.toml",
76-
"temp_analysis/escape2020\\cds-astro_aladin-lite\\aladin-lite-3.3.2\\src\\core\\al-api\\Cargo.toml",
77-
"temp_analysis/escape2020\\cds-astro_aladin-lite\\aladin-lite-3.3.2\\src\\core\\al-core\\Cargo.toml",
78-
"temp_analysis/escape2020\\cds-astro_aladin-lite\\aladin-lite-3.3.2\\src\\core\\al-task-exec\\Cargo.toml",
79-
"temp_analysis/escape2020\\cds-astro_cds-moc-rust\\cds-moc-rust-main\\Cargo.toml",
80-
"temp_analysis/escape2020\\cds-astro_cds-moc-rust\\cds-moc-rust-main\\crates\\cli\\Cargo.toml",
81-
"temp_analysis/escape2020\\cds-astro_cds-moc-rust\\cds-moc-rust-main\\crates\\set\\Cargo.toml",
82-
"temp_analysis/escape2020\\cds-astro_cds-moc-rust\\cds-moc-rust-main\\crates\\wasm\\Cargo.toml",
83-
"temp_analysis/escape2020\\cds-astro_mocpy\\mocpy-0.15.0\\Cargo.toml",
84-
"temp_analysis/escape2020\\escape2020_school2022\\school2022-1.0\\docs\\themes\\dream\\package.json",
85-
"temp_analysis/escape2020\\escape2020_school2022\\school2022-1.0\\testing\\fibonacci\\setup.cfg",
86-
"temp_analysis/escape2020\\gammapy_gammapy\\gammapy-1.2\\setup.cfg"
101+
"temp_analysis/escape2020/gammapy_gammapy/gammapy-1.2/setup.cfg",
102+
"temp_analysis/escape2020/cosimoNigro_agnpy/agnpy-master/setup.py",
103+
"temp_analysis/escape2020/IndexedConv_IndexedConv/IndexedConv-1.3.2/setup.py",
104+
"temp_analysis/escape2020/cds-astro_cds-moc-rust/cds-moc-rust-main/Cargo.toml",
105+
"temp_analysis/escape2020/cds-astro_mocpy/mocpy-0.15.0/Cargo.toml",
106+
"temp_analysis/escape2020/cds-astro_aladin-lite/aladin-lite-3.3.2/package.json",
107+
"temp_analysis/escape2020/escape2020_school2022/school2022-1.0/docs/themes/dream/package.json"
87108
]
88109
},
89110
"authors": {
90111
"count": 2,
91112
"files": [
92-
"temp_analysis/escape2020\\FairRootGroup_FairMQ\\FairMQ-master\\AUTHORS",
93-
"temp_analysis/escape2020\\R3BRootGroup_R3BRoot\\R3BRoot-jun24\\AUTHORS"
113+
"temp_analysis/escape2020/R3BRootGroup_R3BRoot/R3BRoot-jun24/AUTHORS",
114+
"temp_analysis/escape2020/FairRootGroup_FairMQ/FairMQ-master/AUTHORS"
94115
]
95116
},
96117
"contributors": {
97-
"count": 3
118+
"count": 3,
119+
"files": [
120+
"output_4.json",
121+
"output_11.json",
122+
"output_5.json"
123+
]
98124
},
99125
"license": {
100126
"count": 17
101127
},
102128
"codemeta.json": {
103-
"count": 16,
129+
"count": 15,
104130
"files": [
105-
"temp_analysis/escape2020\\aardk_jupyter-casa\\jupyter-casa-master\\codemeta.json",
106-
"temp_analysis/escape2020\\AMIGA-IAA_hcg-16\\hcg-16-1.2.3\\codemeta.json",
107-
"temp_analysis/escape2020\\cds-astro_aladin-lite\\aladin-lite-3.3.2\\codemeta.json",
108-
"temp_analysis/escape2020\\cds-astro_cds-moc-rust\\cds-moc-rust-main\\codemeta.json",
109-
"temp_analysis/escape2020\\cds-astro_mocpy\\mocpy-0.15.0\\codemeta.json",
110-
"temp_analysis/escape2020\\cds-astro_tutorials\\tutorials-1.0.3\\codemeta.json",
111-
"temp_analysis/escape2020\\cosimoNigro_agnpy\\agnpy-master\\codemeta.json",
112-
"temp_analysis/escape2020\\explore-platform_g-tomo\\g-tomo-2\\codemeta.json",
113-
"temp_analysis/escape2020\\FairRootGroup_FairMQ\\FairMQ-master\\codemeta.json",
114-
"temp_analysis/escape2020\\gammapy_gammapy\\gammapy-1.2\\codemeta.json",
115-
"temp_analysis/escape2020\\IndexedConv_IndexedConv\\IndexedConv-1.3.2\\codemeta.json",
116-
"temp_analysis/escape2020\\javierrico_gLike\\gLike-master\\codemeta.json",
117-
"temp_analysis/escape2020\\JColl88_sdc1-solution-binder\\sdc1-solution-binder-1.0.0\\codemeta.json",
118-
"temp_analysis/escape2020\\R3BRootGroup_R3BRoot\\R3BRoot-jun24\\codemeta.json",
119-
"temp_analysis/escape2020\\repo\\eossr-master\\codemeta.json",
120-
"temp_analysis/escape2020\\repo\\eossr-master\\eossr\\metadata\\schema\\codemeta.json"
131+
"temp_analysis/escape2020/gammapy_gammapy/gammapy-1.2/codemeta.json",
132+
"temp_analysis/escape2020/cosimoNigro_agnpy/agnpy-master/codemeta.json",
133+
"temp_analysis/escape2020/IndexedConv_IndexedConv/IndexedConv-1.3.2/codemeta.json",
134+
"temp_analysis/escape2020/cds-astro_cds-moc-rust/cds-moc-rust-main/codemeta.json",
135+
"temp_analysis/escape2020/aardk_jupyter-casa/jupyter-casa-master/codemeta.json",
136+
"temp_analysis/escape2020/cds-astro_tutorials/tutorials-1.0.3/codemeta.json",
137+
"temp_analysis/escape2020/R3BRootGroup_R3BRoot/R3BRoot-jun24/codemeta.json",
138+
"temp_analysis/escape2020/AMIGA-IAA_hcg-16/hcg-16-1.2.3/codemeta.json",
139+
"temp_analysis/escape2020/repo/eossr-master/codemeta.json",
140+
"temp_analysis/escape2020/JColl88_sdc1-solution-binder/sdc1-solution-binder-1.0.0/codemeta.json",
141+
"temp_analysis/escape2020/explore-platform_g-tomo/g-tomo-2/codemeta.json",
142+
"temp_analysis/escape2020/cds-astro_mocpy/mocpy-0.15.0/codemeta.json",
143+
"temp_analysis/escape2020/javierrico_gLike/gLike-master/codemeta.json",
144+
"temp_analysis/escape2020/cds-astro_aladin-lite/aladin-lite-3.3.2/codemeta.json",
145+
"temp_analysis/escape2020/FairRootGroup_FairMQ/FairMQ-master/codemeta.json"
121146
]
122147
},
123148
"zenodo.json": {
124-
"count": 0,
125-
"files": []
149+
"count": 5,
150+
"files": [
151+
"temp_analysis/escape2020/cosimoNigro_agnpy/agnpy-master/.zenodo.json",
152+
"temp_analysis/escape2020/cds-astro_cds-moc-rust/cds-moc-rust-main/.zenodo.json",
153+
"temp_analysis/escape2020/aardk_jupyter-casa/jupyter-casa-master/.zenodo.json",
154+
"temp_analysis/escape2020/javierrico_gLike/gLike-master/.zenodo.json",
155+
"temp_analysis/escape2020/FairRootGroup_FairMQ/FairMQ-master/.zenodo.json"
156+
]
126157
},
127158
"identifier_extract": {
128-
"count": 6,
159+
"count": 7,
129160
"extracted_values": [
130-
"10.5281/zenodo.1689985",
131-
"10.5281/zenodo.4055175",
132161
"10.5281/zenodo.3967385",
162+
"10.5281/zenodo.7544514",
163+
"https://zenodo.org/badge/latestdoi/224865065",
164+
"10.5281/zenodo.1689985",
133165
"10.5281/zenodo.3967385",
134166
"10.5281/zenodo.10405177",
135-
"10.5281/zenodo.7544514"
167+
"10.5281/zenodo.4055175"
136168
]
137169
},
138170
"None": {
139171
"count": 0
140172
}
141173
}
142174
```
175+
> [!WARNING]
176+
> Should be noted, that due to the large size of the files for `temp_analysis`, this directory is not be available on this repository, it is impossible to upload it on GitHub, you can extract using `SoMEF` (it automatically keeps the `temp_files`). From these results, we can answer all RQs.
143177
144-
Should be noted, the "files" section is not be available due to the size of each repositories, it is impossible to upload it on GitHub, they are extracted from SOMEF. From these results, we can answer RQ1.
145-
146-
178+
If you choose to calculate the results of the cluster you will get the following output:
147179
180+
```bash
181+
{
182+
"escape": {
183+
"cff": 5.88235294117647,
184+
"readme": 100.0,
185+
"package": 41.17647058823529,
186+
"authors": 11.76470588235294,
187+
"contributors": 17.647058823529413,
188+
"license": 100.0,
189+
"codemeta": 88.23529411764706,
190+
"zenodo": 29.411764705882355,
191+
"zenodo_doi": 41.17647058823529,
192+
"none": 0.0
193+
}
194+
}
195+
```
148196
149197

0 commit comments

Comments
 (0)