llnl / llnl/ExaCMech

Improve documentation / add option to output parameter names

Open
#18 2 comments 0 reactions 1 assignee View on GitHub

@rcarson3 is already working on this.

Since Nov 2, 2021.

documentation enhancement
Dominant language
C++
Stars
25
Forks
2
PR merge metrics
No merged PRs in 30d

Description

@nrbertin brought up a good point while he was using the python bindings that it would be nice to see what the property names are for each model. We are definitely lacking in this area, and the only place that I believe has all the parameters labelled is my script for ExaConstit: https://github.com/LLNL/ExaConstit/blob/exaconstit-dev/scripts/ecmech_prop_file.py

So, my suggestions would be to add a new function that outputs the model parameter names in a human readable format rather than the blob of numbers that getParams would return. This call should also be able return the names and values if they've already been provided.

I'll see if I can't get to this at the start of the new years as part of improving documentation through-out the code.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.