As discussed in #32 and #61, there is interest in the significant effort required to document all of the API variable address names, and the internal MODFLOW6 variables that those addresses allow users to access. I know that at Groundwater Modeling and More 2026, the MODFLOW team expressed support for getting this documentation created. I am very thankful for that! I, and I'm sure many others using the MODFLOW-API, would also be able to help in small ways. If the MODFLOW team is open to this idea, I would love to see the creation of either a wiki on this github page or .md/README file within the repo itself. As users experiment and learn about various variable addresses and the nuances of the API, we could contribute pull requests that update the wiki or README with information about the API. I'm sure some users are interested in various applications, packages, etc - by making it a community effort, we can more quickly document the API by focusing individually on documenting our particular use cases and interests.
Of course, these community contributions would have to be vetted by MODFLOW developers, and perhaps that is more work than simply writing yourselves. But if this suggestion could help accelerate documentation for the API, I would love to chat more about it. Thank you!
As discussed in #32 and #61, there is interest in the significant effort required to document all of the API variable address names, and the internal MODFLOW6 variables that those addresses allow users to access. I know that at Groundwater Modeling and More 2026, the MODFLOW team expressed support for getting this documentation created. I am very thankful for that! I, and I'm sure many others using the MODFLOW-API, would also be able to help in small ways. If the MODFLOW team is open to this idea, I would love to see the creation of either a wiki on this github page or .md/README file within the repo itself. As users experiment and learn about various variable addresses and the nuances of the API, we could contribute pull requests that update the wiki or README with information about the API. I'm sure some users are interested in various applications, packages, etc - by making it a community effort, we can more quickly document the API by focusing individually on documenting our particular use cases and interests.
Of course, these community contributions would have to be vetted by MODFLOW developers, and perhaps that is more work than simply writing yourselves. But if this suggestion could help accelerate documentation for the API, I would love to chat more about it. Thank you!