Skip to content

Commit

Permalink
fix(build_index script): Including YML and YAML files compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
caviri authored and github-actions[bot] committed Sep 8, 2024
1 parent 0491c6f commit 1625afd
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/scripts/build_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def read_yaml_files(base_path, folders):
yaml_files = []
for folder in folders:
folder_path = base_path.joinpath(folder)
for yaml_file in folder_path.glob('*.yaml'):
for yaml_file in list(folder_path.glob('*.yaml')) + list(folder_path.glob('*.yml')):
with open(yaml_file, 'r', encoding='utf-8') as f:
yaml_files.append((folder, yaml.safe_load(f)))
return yaml_files
Expand Down
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ This is an example of a hackathon project proposing a Research Data Infrastrucre

## Features of this RDI Hub

- **Catalog of related assets**: These are cards
- **Contributions & revision guidelines**:
- **Automations**:
- **Static landing page**:
- **Blog**:
- **Interative serverless webapps**:
- **Catalog of related assets**: These are resources cards contained in the catalog.
- **Contributions & revision guidelines**: Guidelines TBD
- **Automations**: Github actions
- **Static landing page**: Page built in gh-pages.
- **Blog**: TBD
- **Interative serverless webapps**: TBD
- **Tutorials**: Basic operations


This RDI Hub follow the FAIR principles:

- Findability: It helps to find related assets via the catalog and the static landing page.
- Accesibility:
- Accesibility: The datasets are provided in a cloud friendly format reducing the friction of access. Interactive serverless tutorials are planned to be provided.
- Interoperability: The catalog follows the schema located in `./catalog/schemas/` and is available in machine-readable format allowing for easy interaction between tools, programming languages, and frameworks.
- Reproducibility: The mandatory request of D.O.I. of each asset used increase the reproducibility of the results in related

Expand Down Expand Up @@ -64,7 +64,6 @@ Each of these assets type has one basic metadata file requested.
5. The PR approval will trigger a github action, validating the item added.
6. The action will render the new information in the page


#### How to add a new project to this Hub?

TBD
Expand All @@ -79,15 +78,21 @@ Adding or editing a research schema is as easy a modifying one of the files loca

### How the community can add a new webapp?

Making use of the last development in webassembly technologies
Making use of the last development in webassembly technologies.

Ideas for serverless apps:

- Include stlite form
- Include jupyter lite application


### How the page is built?

### How is the roadmap organized?
TBD

Open issues are registered in the repository and taken by the community.
### How is the roadmap organized?

Open issues are registered in the repository and addressed by the community.

## Development

Expand Down
32 changes: 31 additions & 1 deletion src/index.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"index_timestamp": "2024-09-08 16:45:29.626056",
"index_timestamp": "2024-09-08 16:50:41.941809",
"catalog": {
"datasets": [
{
Expand Down Expand Up @@ -35,6 +35,36 @@
"license": "CC BY 4.0",
"access_url": "https://zenodo.org/record/7426506/",
"documentation_url": "https://zenodo.org/record/7426506"
},
{
"schema_version": "1.0.0",
"schema_type": "dataset",
"dataset_id": "0002-pneuma-vision-dataset",
"title": "pNEUMA vision dataset",
"doi": "10.5281/zenodo.10491409",
"version": "v1",
"description": "The pNEUMA dataset is the drone traffic imagery dataset that contains images of frame and vehicle annotations as positions. This dataset is the expansion of the pNEUMA, the urban trajectory dataset collected by swarms of drones in Athens. For more details about pNEUMA and pNEUMA Vision, please check our website at https://open-traffic.epfl.ch and github.",
"created_at": "2023-08-30T15:12:56Z",
"updated_at": "2023-08-30T15:12:56Z",
"data_format": "csv jpg",
"tags": [
"traffic",
"GNSS",
"urban mobility",
"traffic safety"
],
"source": "Zenodo",
"authors": [
{
"name": "Barmpounakis, Emmanouil"
},
{
"name": "Geroliminis, Nikolas"
}
],
"license": "CC BY 4.0",
"access_url": "https://zenodo.org/record/10491409",
"documentation_url": "https://zenodo.org/record/10491409"
}
]
}
Expand Down

0 comments on commit 1625afd

Please sign in to comment.