Updated docs, with experiment & inventory and use existing info #84
Conversation
* made cosmetic change to the Experiment and Inventory chart * added a row for inventory, since we had experiment above it to show inventory example as well
|
when we make the release, I think we can go ahead and merge this in |
| | pick from `Name` column of <a href="https://criptapp.org/keys/material-identifier-key/" target="_blank">material identifiers</a> | identifier | no | your values | | ||
| | pick from `Name` column of <a href="https://criptapp.org/keys/material-property-key/" target="_blank">material properties</a> | property | no | your values | | ||
| | use_existing | property | no | TRUE, FALSE, or blank | | ||
| | \*use_existing | property | yes | project name or FALSE | |
There was a problem hiding this comment.
I think this is great currently and it is enough to get the job done.
I thought we made a feature that it would be project name and we would use_existing and if it is False or empty then we wouldn't? Are we still thinking of adding that feature later? Or am I getting it fully wrong?
I'm thinking if the user has to write a 100 rows of False they'll get angry with us very quickly
| <summary> Notes on material attributes </summary> | ||
| All attributes material can be added by marking the column as attribute in row 1 and using the attribute name from the <a href=https://chemrxiv.org/engage/api-gateway/chemrxiv/assets/orp/resource/item/6322994103e27d9176d5b10c/original/main-supporting-information.pdf>data model</a>. | ||
| Additionally, for the more complex formatting of the computational_forcefield attribute reference the picture below: | ||
| <img src="../docs_assets/comp_forcefield_setup.png" alt="picture of computational forcefield setup"> |
There was a problem hiding this comment.
how come we decided not to go with HTML table? I think the image is fine, but just wondering
docs/individual_sheets.md
Outdated
|
|
||
| <details> | ||
| <summary>Notes on multiple software_configurations</summary> | ||
| Use the Id syntax described in <a href="excel_rows.md" target=_blank>Structure of Excel Sheets </a> to have multiple software_configurations in your Computation node |
There was a problem hiding this comment.
I would give an example here because chances are the user probably skipped a bunch of pages and when they get to here and are looking at it they'll get confused and have a hard time figuring it out
| `use_existing` column field is best for when you already have a material within your project and | ||
| you just want to name it and use it within your Excel file instead of creating a new material on every upload | ||
|
|
||
| <details> |
There was a problem hiding this comment.
great use of regular HTML to make the documentation less ties to a specific software and be more compatible overall!
|
@CVilla17 do you want to put in the I'm thinking we told them that they can use IDs but a user on their first attempt probably misses a lot of things and repetition could help. Just a suggestion, we don't have to if we don't want to |
|
overall it is great, and we can merge it into |
Descript
Checklist