search

GeodynamicWorldBuilder / WorldBuilder

World Builder: An initial conditions generator for geodynamic modeling
GNU Lesser General Public License v2.1
23 stars 29 forks source link

[Tracking Issue] Improve Parameter Documentation #766

Open danieldouglas92 opened 3 weeks ago

danieldouglas92 commented 3 weeks ago

My lab-mate @PrajaktaPMohite and I were working on a worldbuilder file that included faults for one of her models and when we looked at the manual in the section called Parameter Documentation/Features we noticed that this section is almost entirely empty (except for the Plume feature).

Similar to the developer / API documentation issue I thought I would create an issue for this part of the manual so that there is a reminder that this needs to be completed as well.

@MFraters Is the idea that each of these features will be expanded into another drop down list showcasing the various temperature and composition models that they support as well?

MFraters commented 3 weeks ago

Yes, that is a good point. Thanks for creating this tracking issue! You can also add the plume to the list and check if off for completeness :)

@MFraters Is the idea that each of these features will be expanded into another drop down list showcasing the various temperature and composition models that they support as well?

Yes, the idea of this sections is that if you quickly want to know how a feature works and what parameteres there are, this would be easier to read then the actual full parameter documentation. Although I don't know what format would work best for this, so if you or @PrajaktaPMohite want to give it a shot, feel free to experiment!