Tests and publication of JSON schema

[TeresiaOlsson]

I have generated the full JSON schema for the accelerator and I'm now writing the documentation for how to use it to get help to write the documentation.

Here is the current version:
accelerator.schema.json

I plan to include two options:

1. Use the JSON schema functionality in VS Code: I'm working on figuring out all the extensions and settings needed for this.

2. Use the MetaConfigurator: for this it would be useful with more testers to find potential bugs both in the schema and in the metaconfigurator. I have changed the schema now to use oneOf instead of anyOf which seems so far to work and provides a nicer user interface. I have also found some bugs that the developers said they are planning to fix before next week.

For now I think we should use the development version to get the bug fixes: https://metaconfigurator.github.io/meta-configurator/data

Then the question is where to publish the schema. In the metaconfigurator (and maybe also in VS Code, need to check) it's possible to load a schema from an url which is very convenient. But that raises where on github this schema should be stored.

I can think of three options:

1. In the pyaml repository
2. In a separate pyaml-schema repository
3. In the pyaml-test-lattice repository

What do you think? I'm currently leaning towards maybe a separate repository since the schema includes more than just classes that are in the pyaml repository. It's also possible that we can have there schemas for subparts of the accelerator to make it easier to use the external tools also if you want to use the option to separate the configuration into many files.

[TeresiaOlsson]

@simoneliuzzo If you have time, can you test how user-friendly you think it is now if you go to the metaconfigurator page and load the schema I attached?

If that works well and we combine with #400 I think the threshold for new users to make the configuration should be much lower than before. It is still going to be the case that they won't always know which element to choose for their specific hardware but that I think is unavoidable. For that they need to look in the documentation for the different elements.

[simoneliuzzo]

Dear @TeresiaOlsson ,

I downloaded the accelerator.schema.json and opened it with https://metaconfigurator.github.io/meta-configurator/data
This was easy.

What should I be able to do with it now?

best regards
simone

[TeresiaOlsson]

Now you should hopefully see on the right different menus where you can type in values and choose the options you want. And on the left the yaml file will be written based on your choices.

[TeresiaOlsson]

The graphics for this tool is not perfect and some things are a bit confusing. But I hope it can help when you are starting from a blank file and tell you which options that are available at each level.

At least I think we can use this tool as a start and get feedback so we in the future maybe can make our own pyAML specific GUI tool based on what the users liked.

[simoneliuzzo]

Dear @TeresiaOlsson ,

I see this:

[TeresiaOlsson]

Ahh. You are in the schema part where it's possible to modify the schema. You want to be in the data part. On the top menu is it possible to change to data?

The right menu option should look like this:

[TeresiaOlsson]

At the moment the class fields are not prefilled which is annoying. I have made an issue about that so hopefully it gets fixed.

[simoneliuzzo]

Dear @TeresiaOlsson,
Than I think I did something wrong loading.
my Data page is different (see image above)

[simoneliuzzo]

I think I loaded the schema in the data. I try again.

[TeresiaOlsson]

The schema part of this tool is still a mystery for me. It has also happened to me sometimes that I ended up in that part and then I was all confused and couldn't get out.

[simoneliuzzo]

Now I see the schema (rather difficult to navigate and slow to load)
and the fillable fields as you showed in the data panel.

[TeresiaOlsson]

Hmm... It's still not right. I got the page I posted by doing this:

• I go to this link: https://metaconfigurator.github.io/meta-configurator/data
• I click away the annoying "get in touch message"
• Then I choose "Open schema file"

I'm guessing you also do that but for some reason you end up in the schema menu. On the top left it says "Data" and "Schema" but for you it looks like "Schema" is the tab you are on whereas I end up on the tab "Data".

[TeresiaOlsson]

What happens if you try to click on the "Data" tab? I tried to do it after I was on the "Schema" tab like you. First it didn't do anything (I guess because our schema is so large and slowing down the browser...) but after several clicks it finally changed to the other option.