Skip to content

Add more Neo content types#62

Open
UlrikeS91 wants to merge 42 commits intomainfrom
UlrikeS91-CoTy-Neo
Open

Add more Neo content types#62
UlrikeS91 wants to merge 42 commits intomainfrom
UlrikeS91-CoTy-Neo

Conversation

@UlrikeS91
Copy link
Copy Markdown
Contributor

@UlrikeS91 UlrikeS91 commented May 6, 2024

This will replace openMetadataInitiative/openMINDS_core#299.

The comments are in relation to the original PR from @JuliaSprenger and the review comments from @lzehl and @apdavison:

  • “alphaomega0.jsonld”: changed to “application_vnd.alphaomega.v0-eng.jsonld”
    • 0 changed to v0 as suggested by @apdavison
    • “-eng” most likely stands for “engineering” since it is part of the company name and also of their homepage URL (Alpha Omega Engineering - https://www.alphaomega-eng.com/)
  • “axon.jsonld”: removed since @apdavision pointed out that this is a duplicate; @JuliaSprenger please use “moleculardevices.axon.jsonld” instead
  • “axona.jsonld”: changed to “application_vnd.axona.jsonld”
    • no content change, just update to new convention
  • “biocam+hdf.jsonld”: changed to “application_vnd.biocam+hdf5.jsonld”
    • updated “hdf” to “hdf5” in accordance with similar instances
    • added file extension “.hdf5” in accordance with similar instances
    • changes synonym in accordance with similar instances
  • “klustakwik.jsonld”: changed to “application_vnd.klustakwik.jsonld”
    • no content change, just update to new convention
  • “maxwell.jsonld”: changed to “application_vnd.maxwell+hdf5.jsonld”
    • updated “hdf” to “hdf5” in accordance with similar instances
    • added file extension “.hdf5” in accordance with similar instances
    • changes synonym in accordance with similar instances
  • existing “application_vnd.mearec.jsonld”: updated to “application_vnd.mearec+hdf5.jsonld”
    • added file extension “.hdf5” in accordance with similar instances
    • changes synonym in accordance with similar instances
  • "neo+pickle.jsonld": changed to "application_vnd.neuralensemble.neo+pickle.jsonld" (following suggestion of @apdavison)
    • otherwise no content change, just update to new convention
  • existing "application_vnd.neuroscope.jsonld": update with more content from "neuroscope.jsonld"
  • existing "application_vnd.neuroshapeapi.jsonld": updated to "application_vnd.neuroshape.api.jsonld" (following suggestion of @apdavison)
  • "neurosharetypes.jsonld": changed to "application_vnd.neuroshape.types.jsonld"
  • "numpy.jsonld": changed to "application_vnd.numpy.array.jsonld"
    • changed synonym
    • added description (because it was super easy to find)
  • existing "application_vnd.openephys.jsonld": updated with more content from PR
  • "phy.jsonld": changed to "application_vnd.phy.jsonld"
  • existing "application_vnd.spike2.sonpy.son" split into 32 and 64 bit version in accordance with PR and @apdavison suggestion for the synonym
  • "spikegadgets.jsonld": changed to "application_vnd.spikegadgets.jsonld"
  • existing "application_vnd.spikeglx.system.jsonld": updated with more content from "spikeglx.jsonld"
  • existing "application_vnd.tdt.jsonld": updated with more content from "tdt.jsonld"

Open questions:

  • should "application_vnd.neuroshape.types.jsonld" exist? @apdavision raised this question ("Does Neuroshare have its own file format(s)? I thought it was just an API to read in some existing formats.")
  • should "application_vnd.phy.jsonld" exist? @apdavison raised the question "What is different in phy files compared to simple .npy?"; I found this: https://phy.readthedocs.io/en/latest/. Not sure if it helps.

Additionally added:

  • "application_vnd.numpy.multiarray.jsonld" since it was mentioned by @apdavison in relation to the array

@UlrikeS91 UlrikeS91 marked this pull request as ready for review May 6, 2024 12:28
@UlrikeS91 UlrikeS91 requested review from apdavison and lzehl May 6, 2024 12:29
@UlrikeS91
Copy link
Copy Markdown
Contributor Author

@JuliaSprenger is also very welcome to review this PR and give feedback. I hope that I migrated everything correctly.

@UlrikeS91 UlrikeS91 added the ContentType ContentType instances - addition of new or update of existing ones label May 8, 2024
@lzehl lzehl self-assigned this Oct 14, 2024
Copy link
Copy Markdown
Member

@lzehl lzehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to new namespace

Copy link
Copy Markdown
Member

@lzehl lzehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also like to have a one sentence description for each. @apdavison I think we should discuss those in detail.

".lsx",
".mpx"
],
"name": "application/vnd.alphaomega.v0-eng",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"name": "application/vnd.alphaomega.v0-eng",
"name": "application/vnd.alphaomega-eng.v0",

if -eng belongs to the company name and v0 points to the version it should be this way around, no? @apdavison

Comment on lines +17 to +20
"synonym": [
"MaxOne HDF5",
"MaxTwo HDF5"
]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a bit weird, MaxOne and MaxTwo are different MEA systems. If they are using the same file format the synonym of the file format should not be combined with the system name (unless this is what they officially do). I would suggest calling this MaxWell HDF5, or MaxWell Biosystems HDF5

"dataType": null,
"description": null,
"displayLabel": null,
"fileExtension": null,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No extension? is this not a content type for files but for bundles?

"dataType": null,
"description": null,
"displayLabel": null,
"fileExtension": null,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no extensions? is this for bundles not for files?

"@id": "https://openminds.om-i.org/instances/contentTypes/application_vnd.numpy.multiarray",
"@type": "https://openminds.om-i.org/types/ContentType",
"dataType": null,
"description": "File format by numpy that provides storage of array data using gzip compression.",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "File format by numpy that provides storage of array data using gzip compression.",
"description": "A compressed archive format used by NumPy to store a collection of individual NumPy arrays (.npy files) in a single zip archive file.",

"fileExtension": [
".npz"
],
"name": "application/vnd.numpy.multiarray",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@apdavison should this be ?

Suggested change
"name": "application/vnd.numpy.multiarray",
"name": "application/vnd.numpy.multiarray+zip",

"description": null,
"displayLabel": null,
"fileExtension": null,
"fileExtension": [
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this really one content type? or rather different ones?

"fileExtension": [
".smr"
],
"name": "application/vnd.spike2-32.sonpy.son",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"name": "application/vnd.spike2-32.sonpy.son",
"name": "application/vnd.spike2.sonpy-binary32",

what was the .son for?

we need to define a convention of bitness for our content types

"fileExtension": [
".smrx"
],
"name": "application/vnd.spike2-64.sonpy.son",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

convention for bitness should be different I think (see spike2-32)

@lzehl
Copy link
Copy Markdown
Member

lzehl commented Jun 24, 2025

@apdavison @UlrikeS91 it seems that all content types from this PR are already in openMINDS. Before we continue we should double check this.

Copy link
Copy Markdown

@ree-gupta ree-gupta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added my comments for the two formats in the PR that I am familiar with.

Comment on lines +11 to +14
".tsq",
".tbk",
".tev",
".sev"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
".tsq",
".tbk",
".tev",
".sev"
".tsq",
".tbk",
".Tbk",
".Tdx",
".tev",
".tnt",
".sev"

"displayLabel": null,
"fileExtension": null,
"fileExtension": [
".bin",
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't .bin generic? should we be more specific using the stream names? that is,.ap.bin, .lf.bin and .nidq.bin? Unless the system allows user-defined stream name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ContentType ContentType instances - addition of new or update of existing ones

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants