search

NordicESMhub / OsloCTM3

Oslo CTM3 – A global chemical transport model
MIT License
2 stars 5 forks source link

documentation #1

Open annefou opened 5 years ago

annefou commented 5 years ago

For documentation, you can either have it as part of the master branch, or create a new branch (for instance gh-pages to have an online manual) or create a new repository (such as OsloCTM3-docs.

What do you prefer?

ziu1986 commented 5 years ago

It think an online manual might be a good choice. In fact, I made very good experience with doxygen - but I see that it takes some effort to put it in place. Currently, all documentation is in the manual_osloctm3.pdf - I do not have access to the presumable source tex-file.

We probably might need a new repository for the so called "utilities" (I have not added it to this git-repo.).

I'm not sure, how we should handle subdirectories like tables and c3run. I would love to keep actual model code more separate from input and steering files. What does the "manual on software engineering" (best-practice) say about this?

annefou commented 5 years ago

doxygen is nice for code documentation (documentation for developers) but it is also nice to have a user manual. We should try to get tex files for manual_osloctm3.pdf; We could also use the wiki of the repository (actually it is another separate repository).

At least, I can create a new repository OsloCTM3-utilities.

ziu1986 commented 5 years ago

doxygen: In fact, Amund has left the code fairly god commented which could be used for doxygen. I have to admit that I sometimes do not work so thoroughly ;-) User-manual: I will asked Amund for the manual.tex. Shall I also invite him to join the OsloCTM3-git-repo? Utilities: I do not really know, what's in there, but I also have some utilities of my own which might actually do the same ;-) (we have: fast_jx fortan generateOpenIFS idl matlab python)

annefou commented 5 years ago

I don't know all the utilities available; some are supposed to be used to generate OsloCTM3 inputs from OpenIFS outputs. Maybe we shoudl look at them before adding anything into a github repo.

We can definitely add Amund to the OsloCTM3 git repositories.

ziu1986 commented 5 years ago

Inviting Amund Done.

ziu1986 commented 5 years ago

I have updated the "quickstart" in the README. Total newbies may still not understand it, though.