search

SticsRPacks / SticsRFiles

Read and modify STICS input/output files:
https://sticsrpacks.github.io/SticsRFiles
GNU Lesser General Public License v3.0
3 stars 4 forks source link

Clarify the doc of `gen_usms_xml2txt` #98

Open timflutre opened 4 months ago

timflutre commented 4 months ago

Clarify the doc of gen_usms_xml2txt

Expected Behavior

The doc of argument javastics should be "Path of JavaSTICS (needed if the JavaSTICS converter is used, java_converter set to TRUE in inputs, otherwise needed to retrieve some extra files)".

Current Behavior

The current doc of argument javastics is "Path of JavaSTICS. Optional (needed if the JavaSTICS converter is used, java_converter set to TRUE in inputs)".

Failure Information (for bugs)

Currently, if javastics is not set and the file tempopar.sti is missing, this file will not be retrieved and any subsequent call to stics_wrapper will fail.

Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

plecharpent commented 4 months ago

Hi @timflutre,

You are right the documentation and vignette/examples have to be updated and completed.

Without using the JavaStics converter, the param_gen.xml and param_newform.xml files must exist in the workspace folder to obtain the text equivalent files.

Thanks.