Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move documentation to new repository #1

Open
4 tasks
pb866 opened this issue Apr 2, 2019 · 4 comments
Open
4 tasks

Move documentation to new repository #1

pb866 opened this issue Apr 2, 2019 · 4 comments
Assignees
@pb866
Labels
decision A decision is needed to progress documentation Issues related with the manual or documentation in the source code. strategy Discussions about development strategies and promoting Mistra structure Issues related to folder structure or structure of the source code
Milestone
Long-term develop...

Comments

@pb866
Copy link

pb866 commented Apr 2, 2019 •
edited
Loading

  • Create new repository for documentation
  • Update Latex-files from version 8 to version 9
  • In the long run, transfer Latex-files to md-files and create a wiki in the Mistra repository
  • Include to-do-list from Improve documentation #5
@pb866 pb866 added the documentation Issues related with the manual or documentation in the source code. label Apr 2, 2019
@pb866 pb866 self-assigned this Apr 2, 2019
@rs028
Copy link
Collaborator

rs028 commented Apr 2, 2019

What do you mean a new repo? Shouldn't it stay in the Mistra repo?

@pb866
Copy link
Author

pb866 commented Apr 2, 2019

We can either have the latex files in the doc folder or move them to a new repo. I would keep the Mistra repo rather clean and outsource unnecessary/unrelated code to separate repos.
Having the documentation outsourced, we could also think to make the repo private as probably no one needs to know the latex code and only cares about the pdfs. I would make releases and attach pdfs of the manual and precompiled binaries to it. Or, we could have a public repo with the latex files and include it as a git submodule. It would help structuring the Mistra repo.

@rs028
Copy link
Collaborator

rs028 commented Apr 2, 2019

I see what you mean. I would be more inclined to keep the tex files together with the code. I think it makes everything easier, especially from the point of view of the user.

But I guess it makes more sense to have a separate repo (or a submodule), if we want to convert all the documentation to wiki format (i.e., md files) and manage the wiki with git. However, in this case I don't know how to create the pdf file to attach to the release.

@pb866
Copy link
Author

pb866 commented Apr 2, 2019

Fine with me as well, probably worth to have at least a temporary external repo for the moment as the updates of the latex files from version 8 to 9 are not done over night, and then we have an outdated documentation in the Mistra repo.

To update everything to markdown is another story and we need to discuss priorities with the limited resources, we have.

@pb866 pb866 added this to the Mistra v9.0 milestone Apr 5, 2019
rs028 pushed a commit that referenced this issue Jul 29, 2022
@JosueBock
The only important change is a revert with regards to the initialisat…
91f1dd6 
…ion of the vertical profile of pressure: in this context, the layer #1 must be considered as a layer of height detamin, to be consistent with diffusion routines expressions. This improves the consistency of results with previous studies (for instance Joyce14bc).

Other changes are:
In jrate.f, declared all remaining implicit variables, and implicit none. This is now completed for the whole MISTRA code.

In kpp.f90, minor improvements regarding file output, plus other cleaning/commenting.

In Makefile, clarify the recommended flags depending on the compiler. Also updated the module dependencies

In str.f90, improve a few I/O parts of code with file_unit variables instead of hard coded values.

Added file units for:
  - initial atmosphere (file pia.out) and particle (file fia.out) grid descriptors, for plotting
  - ion balance in aerosol (ionba.out) and droplets (ionbd.out) output files
  - final output of aerosol size distribution (aea.out)

Systematic change of outdated character *len statements, use only character (LEN=len) :: statements

Added 3 plotting routines (written with NCL) to reproduce Joyce et al 2014 figures (2, 3, and 4).
@rs028 rs028 changed the title Outsource documentation to new repository Move documentation to new repository Aug 24, 2022
@rs028 rs028 added question Further information is requested strategy Discussions about development strategies and promoting Mistra decision A decision is needed to progress structure Issues related to folder structure or structure of the source code and removed question Further information is requested labels Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pb866 pb866

Labels
decision A decision is needed to progress documentation Issues related with the manual or documentation in the source code. strategy Discussions about development strategies and promoting Mistra structure Issues related to folder structure or structure of the source code
Projects
None yet
Milestone
Long-term developments
Development

No branches or pull requests
2 participants
@rs028 @pb866