add index-metadbs/matcloud #63
Conversation
|
Thanks for addressing our suggestions @jpdong00, the index meta-db you have added looks fine to me. Could you please keep all changes in one pull request? You can just push new changes to the master branch of your fork, and it will automatically update this PR. It's quite hard to track what's going on otherwise! I've copied @CasperWA's previous review comments from the previous PR. |
| "attributes" : { | ||
| "name": "An integrated high-throughput computational materials platform", | ||
| "description": "MatCloud is a high-throughput computing platform integrating data, simulation and supercomputing.", | ||
| "base_url": "http://207.246.86.9:5000/optimade", |
There was a problem hiding this comment.
You don't have a named domain to put in here instead? As otherwise you will have to change this again later once you get that.
Furthermore, The OpenAPI schema shown there does not reflect what would be expected from the named endpoints. See the specification here to understand better how to setup your OPTIMADE implementation (e.g., endpoint names should consist of lowercase alphanumerics and usually be in the plural form, e.g., /structures instead of /Structure).
Originally posted by @CasperWA in #61 (comment)
There was a problem hiding this comment.
Our website is still under construction, and only some of the functions of the optimade specification have been implemented. And for these irregularities, I will carefully check and modify.
Later, the domain name will be unified under MatCloud (http://matcloud.cnic.cn/).
Thank you for your suggestion.
Originally posted by @jpdong00 in #61 (comment)
There was a problem hiding this comment.
Just to add my two cents here, I would suggest setting your base_url here to null for now, until you have finished your implementation. This will reserve the appropriate prefix and signal the intent of matcloud to implement OPTIMADE, but it will prevent your database being used by all OPTIMADE clients/validators until it is finished.
You may be interested in using the validator we have written at (https://github.com/Materials-Consortia/optimade-python-tools) to help finish off your implementation. It is also available as GitHub action (https://github.com/Materials-Consortia/optimade-validator-action) and as a no-install binder repository (https://mybinder.org/v2/gh/ml-evs/optimade-validator-binder/master?filepath=optimade_validator.ipynb) where you can test your current URL.
Thank you again for your patience and guidance @ml-evs , please change the base_url to null. |
There was a problem hiding this comment.
I think this can now be accepted as it these changes just reserve the matcloud prefix and indicate that a MatCloud OPTIMADE implementation is in progress.
Once you have a URL that hosts the OPTIMADE API, @jpdong00 please make another PR to update it here. Hopefully you will find the other tools I linked above useful, good luck!
@CasperWA do you want to double-check this, as the other person who initially reviewed it?
|
@ml-evs Thank you very much, your help is a great encouragement to us. There may be some irregularities now, we will proofread again and continue to implement our website in accordance with the optimade specifications. In addition, there is a small question, how can we display our information on this website (https://www.optimade.org/providers-dashboard/)? |
1 similar comment
|
@ml-evs Thank you very much, your help is a great encouragement to us. There may be some irregularities now, we will proofread again and continue to implement our website in accordance with the optimade specifications. In addition, there is a small question, how can we display our information on this website (https://www.optimade.org/providers-dashboard/)? |
That website is automatically updated once a day based on the providers in this repository. So as soon as you don't have a |
Based on your opinion, the static index meta-databases has been added.
And for some irregularities, I will carefully check and modify.
Thank you for your suggestion.