Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update for me.org #318

Open
ccarouge opened this issue Nov 8, 2024 · 5 comments
Open

Documentation update for me.org #318

ccarouge opened this issue Nov 8, 2024 · 5 comments
Assignees

Comments

@ccarouge
Copy link
Member

ccarouge commented Nov 8, 2024

The current instructions for me.org in the User Guide are erroneous. They don't use the correct benchmarks and they request to change the model profile for each benchcab run when we should only have 1 CABLE profile. All other information about the realisations should be given within the model output.

Also, the User Guide section needs some information about using the automation via the API. It has been added to the config options page but not the "tutorial".

@bschroeter
Copy link
Collaborator

OK, so looking at this, it seems that the "1 CABLE profile" is not available to me for some reason. Only the test profile I created some time ago.

Image

This speaks to the confusion of the relationship between workspaces/experiments/profiles/outputs. Mind you, it could be something as simple as my user not having the correct permissions.

I understand what we want to do in this doc update for the profiles, but I think there is a technical issue preventing my developing a test case to actually rewrite the docs as intended.

I gather from your comments around the tutorial you mean this section?
https://benchcab.readthedocs.io/en/stable/user_guide/

In which case, I suggest we consider setting up the run so that the user need only update their model output ID in the config and everything else is preconfigured on the ME.org end.

In truth, the API with the ability to create model outputs on the server at runtime would negate this entirely. I will reach out to the ME.org devs to get an ETA on this.

@ccarouge
Copy link
Member Author

ccarouge commented Feb 7, 2025

Oh no, I remember now. Model Profiles are personal. You can't use the model profile created by someone else. Don't ask me why it is defined this way. It does not make sense with the way Gab is envisioning this CABLE evaluation would work. He said to use only 1 model profile and put the branch details in comments.

So for the moment, everyone needs to create a generic CABLE profile and then they can reuse their CABLE profile for all their model outputs. Now, I'm assuming they would need to give it a unique name? @bschroeter can we test that please? Can you try and create a model profile named CABLE in benchcab-evaluation?

@bschroeter
Copy link
Collaborator

I can confirm that I can create a test model profile with the name "CABLE". I'm sure that will be confusing for me down the track.

@ccarouge
Copy link
Member Author

ccarouge commented Feb 9, 2025

I'm sure that will be confusing for me

Which part will be confusing?

@bschroeter
Copy link
Collaborator

I'm sure that will be confusing for me

Which part will be confusing?

Just knowing which one I want to use at a given time, nothing serious!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants