search

compdyn / partmc

Particle-resolved stochastic atmospheric aerosol model
http://lagrange.mechse.illinois.edu/partmc/
GNU General Public License v2.0
28 stars 16 forks source link

Review chemistry module documentation #86

Open mattldawson opened 5 years ago

mattldawson commented 5 years ago

Revise all documentation related to the chemistry module

mattldawson commented 4 years ago

Move the doxygen function descriptions to header files

cguzman95 commented 4 years ago

Hi @mattldawson,

I was discussing with Oriol about the subject of passing all the CAMP knowledge to me and leaving all the possible written in a commonplace. We reach the conclusion that all the diagrams and descriptions that I'm doing should be placed in the CAMP Doxygen documentation, and somehow, be linked in the CAMP Gitlab wiki , in the same way, the NMMB-MONARCH Gitlab wiki links his own Doxygen documentation. I will ask the person responsible for doing this in NMMB-MONARCH (Kim) to generate the Doxygen CAMP link through the Gitlab project.

For our part, I will create a branch for this issue and start adding the diagrams and other stuff, alongside a document with the questions that may appear to me. Once the wiki is updated with the link to Doxygen documentation, you and everyone can review it online and help to complete it. In fact, I and Oriol will probably do regular meetings to check the progress of this documentation.

For the moment, all this documentation is located in my Google drive. You can do a quick check to tell me if the diagrams are going in the right direction (another format, other types of diagram, so much/little information in the diagram...) or answer the actual doubts.

mattldawson commented 4 years ago

Hi @cguzman95,

That sounds like a great plan. I will check out your work in Google drive. Let me know if I can help with the Doxygen stuff at all.

cguzman95 commented 4 years ago

I will work in the develop-85-tutorial branch alongside #85 to have the most recent version of the documentation

cguzman95 commented 4 years ago

Hi @mattldawson,

Kim achieves to put the Doxygen documentation online http://www.bsc.es/projects/earthscience/camp/doc/camp_chem.html

But there's a problem: This documentation comes from the chem_mod branch, and I'm currently working on the develop-85-tutorial, so we can't review the last changes online without pulling the changes to the chem_mod branch.

So, what do you think? Oriol should have commented to you about the regular meetings to check this documentation, we should do a pull of the doc/ folder from the develop-85-tutorial branch to the chem_mod each week before the online script compiles the documentation?

mattldawson commented 4 years ago

Hi @cguzman95,

Do we really need it to be online for the development? I don't mind building the documentation locally from develop-85-tutorial. The other option is to ask Kim to temporarily point to the develop-85-tutorial branch to build the online documentation.

Another thing to keep in mind is that if Kim is using the PartMC mirror on the BSC GitLab, this needs to manually refreshed from the upstream repo to see new changes in any branch. (We talked about automating the refresh, but it was never actually put in place.)

I would suggest we just work from develop-85-tutorial manually building the documentation during the development process. Then, we can periodically push to chem_mod and refresh the BSC GitLab mirror as we get major parts of the documentation finished.

What do you think?

cguzman95 commented 4 years ago

Sounds good, and Oriol also agrees with building manually the documentation, so no problem.