vancesteven / PlanetProfile

Construct 1D interior structure models based on planetary properties. Self-consistent thermodynamics are used for fluid, rock, and mineral phases. Sound speeds, attenuation, and electrical conductivities are computed as outputs.
https://vancesteven.github.io/PlanetProfile/
GNU General Public License v3.0
18 stars 13 forks source link

Usability could be improved by addition of documentation describing functions #27

Open itsmoosh opened 3 years ago

itsmoosh commented 3 years ago

As our user base grows, newcomers will necessarily have questions about what's going on under the hood. It will be very helpful if we create a set of documentation files describing the purpose, operational principles, inputs and outputs, and provide comments on usage of all PlanetProfile functions, files, and flags. This will also help with transparency of the scientific process.