Nexus validation tutorial

[RonHildebrandt]

This tutorial is supposed to be a very low entry level for the creation of NeXus files by hardcoding via python. This is therefore not limited to specific experimental techniques. I use NXoptical_spectroscopy as example.The second part is, to use show which methods are right now present, to validate the created files (nxvalidate, punx, pynxtools).

I also added a second .md file, with my experience for validation methods, which are of relevance for development. There are also notes for the installation of cnxvalidate.

Short summary:

1. There are some tools
2. None fulfills all requirements
3. punx and cnxvalidate's development seemed to stopped?
4. Need own validation function?

_____ TODOs ___________

• Add the links to the python and nexus files
• Add contact for feedback

[lukaspie]

Generally, a nice start and quite helpful for the upcoming workshops.

1. I don't see why all the nexus files should be added here, upload them to Zenodo/NOMAD and add a download link if needed.
2. Split the hardcode nxs file creation from the validation.
3. Note that these are the pynxtools docs. Therefore, whenever there is a departure from the envisioned workflow (i.e., pynx-plugin + internal validation vs. hardcoding + external validation), there should be some explanatory text a) why this is useful, and b) that we still recommend people to use pynxtools (and why that is, i.e. automatic tooling + validation).
4. In some places, there are links that could be abbreviated using text. You can build the docs locally using mkdocs serve and check that the links look nice.
5. You need to modify the mkdocs.yaml file as well so that the new docs are actually showing up after the build.

Sorry I was a bit critical in some places. Just suggestions so that people can use the docs more easily :)

[RubelMozumder]

I see that none of them is working properly.

[rettigl]

In this context I suggest to add the relevant verification tools to the nexus north container (I think some are already installed). Then they can be very easily used on Windows.

[lukaspie]

@RonHildebrandt FYI, in #412, I have suggested a new structure for our docs. We then have a page https://fairmat-nfdi.github.io/pynxtools/learn/nexus-verification.html. I think there we could ideally place your verification notes. I intentionally structured it so that we can describe our tools (verification when using pynxtools chain, verify-nexus, read-nexus) first (because we want people to use them), but then also describe other approches like cnxvalidate. What do you think?

[RonHildebrandt]

Hey, thanks @lukaspie @mkuehbach @RubelMozumder for all the feedback and help with improvements. Some ideas I was just simply not aware of (links). The splitting was done as adviced. Many typo changes and use clearer/better terms were included.

I hope this suits now better.

I found 3 other links from How-Tos on the website to be almost "empty". I removed them, as this just looks unprofessional ob the website. I left a note that this is in progress. Not sure if this transforms to the PR412, as I just head from this.

[lukaspie]

mostly typo fixes and structural changes

[lukaspie]

LGTM

[lukaspie]

these should not be removed (even if they are not yet fully fleshed out), I readded them

[lukaspie]

We can leave them in the tree on the left-hand side and say in index.md that they are under development

[RonHildebrandt]

Okay, I put intially somewhere a note that this is deveopled, but not yet ready. If it should be this way, Im fine with that. Just doesn't look profesionally if someone visits this site and sees that 3 guides are construction sites (not sure for how this state is).
anyway, then lets keep it.