search

swung-research / 3d-csem-open-source-landscape

Werthmüller, D., R. Rochlitz, O. Castillo-Reyes, and L. Heagy, 2021, Towards an open-source landscape for 3-D CSEM modelling: Geophysical Journal International, 227(1), 644--659
https://doi.org/10.1093/gji/ggab238
Creative Commons Attribution Share Alike 4.0 International
14 stars 5 forks source link

Scripting language #7

Closed prisae closed 5 years ago

prisae commented 5 years ago

I started with the Geophysics-LaTeX format, as I had that at hand.

But thinking about it, I guess it would be better if we make a Sphinx-doc using .rst-files. This way, a lot would already be rendered simply on GitHub (except math, but there won't be too much of that in this article), and we could link it to rtfd.org to have it compiled properly each time. I think this would be nicer to collaborate on GitHub.

The biggest advantage would be, that at the end we could easily include it, or part of it, into our code documentations for each project (except MARE3DEM, I don't think you use Sphinx for documentation, right?).

The only downside is that at the end we'll have to copy-paste-transfer it to the journal format. But that is a one-time thing and should not take a lot of time.

What do you think? (@lheagy, @Moouuzi, @ocastilloreyes, @kerrykey)

ocastilloreyes commented 5 years ago

I think it is a good option to use sphinx because it would make collaborative work much easier. Although I don't refuse other options.

prisae commented 5 years ago

I changed it last week to sphinx, the paper now lives in the paper-folder. Just run make html in that directory, and then open paper/_build/html/index.html in a browser to see it.