biosimulators / Biosimulators_utils

Utilities for building standardized command-line interfaces for biosimulation software packages
https://docs.biosimulators.org/Biosimulators_utils
MIT License
4 stars 6 forks source link

Add format types to `CombineArchiveContentFormat` #87

Closed bilalshaikh42 closed 2 years ago

bilalshaikh42 commented 2 years ago

https://github.com/biosimulators/Biosimulators_utils/blob/6ce19360af353444bf671f39ca9998dff3c4efff/biosimulators_utils/combine/data_model.py#L161

I have encountered the following file types in PMR workspaces. Some of them might be valid formats to specify in the OMEX manifest as their own types or one of the existing types:

jonrkarr commented 2 years ago

I can add these.

This package is not intended to outline an exhaustive list of formats, just common packages. A format need not be defined in this package for a manifest to be considered valid.

bilalshaikh42 commented 2 years ago

Thanks!

This package is not intended to outline an exhaustive list of formats, just common packages. A format need not be defined in this package for a manifest to be considered valid.

Yup, I figured it might be easier to have one place to define all of them for the code that we write to import models from repositories. Any files that are too obscure to include in this package can certainly be left out. The wording "valid" in the original comment was confusing. "useful" would be a better term

jonrkarr commented 2 years ago

There's also a list in the ontologies module in biosimulations.

What is important is that each format is consistently described with the same URI, particularly for model formats. I've summarized this in the documentation. Through the ontologies module of biosimulations, this is also advertised in the biosimulations API.

jonrkarr commented 2 years ago

Added in 037df87791021fedf23cbf71dddd946a36d8de0a. Will be released with 0.1.153.

Notes

jonrkarr commented 2 years ago

Also added to https://github.com/biosimulations/biosimulations/blob/dev/libs/ontology/extra-sources/src/lib/edam-biosimulations-formats.json so these formats are available through the BioSimulations API.

jonrkarr commented 2 years ago

Also created a few EDAM issues to request terms for the most popular of these formats.