Set up documentation

[jiweiqi]

https://sparkbox.com/foundry/github_wiki_tutorial_for_technical_wiki_documentation

[jiweiqi]

Following https://juliadocs.github.io/Documenter.jl/stable/man/guide/

[jiweiqi]

Now at https://deng-mit.github.io/Arrhenius.jl/dev/ Reference:

• https://github.com/JuliaPOMDP/POMDPs.jl/blob/master/docs/src/index.md

[jiweiqi]

@RSuryaNarayan You can start from this example to get familiar with Arrhenius.jl

[RSuryaNarayan]

Sure @jiweiqi ! Shall go through.

[RSuryaNarayan]

Shall I send a PR for this: https://github.com/RSuryaNarayan/Arrhenius.jl/blob/main/docs/src/get_started.md

[jiweiqi]

@RSuryaNarayan I think it is a good practice to send a PR and get familiar with it.

[RSuryaNarayan]

Sure @jiweiqi I shall send the PR right away

[jiweiqi]

@RSuryaNarayan A very minor remind, you may forget to specify the language for the following code block

@inbounds function dudt!(du, u, p, t)
    T = u[end]
    Y = @view(u[1:ns])
    mean_MW = 1. / dot(Y, 1 ./ gas.MW)
    ρ_mass = P / R / T * mean_MW
    X = Y2X(gas, Y, mean_MW)
    C = Y2C(gas, Y, ρ_mass)
    cp_mole, cp_mass = get_cp(gas, T, X, mean_MW)
    h_mole = get_H(gas, T, Y, X)
    S0 = get_S(gas, T, P, X)
    wdot = wdot_func(gas.reaction, T, C, S0, h_mole)
    Ydot = wdot / ρ_mass .* gas.MW
    Tdot = -dot(h_mole, wdot) / ρ_mass / cp_mass
    du .= vcat(Ydot, Tdot)
end

Without specifying language,

@inbounds function dudt!(du, u, p, t)
    T = u[end]
    Y = @view(u[1:ns])
    mean_MW = 1. / dot(Y, 1 ./ gas.MW)
    ρ_mass = P / R / T * mean_MW
    X = Y2X(gas, Y, mean_MW)
    C = Y2C(gas, Y, ρ_mass)
    cp_mole, cp_mass = get_cp(gas, T, X, mean_MW)
    h_mole = get_H(gas, T, Y, X)
    S0 = get_S(gas, T, P, X)
    wdot = wdot_func(gas.reaction, T, C, S0, h_mole)
    Ydot = wdot / ρ_mass .* gas.MW
    Tdot = -dot(h_mole, wdot) / ρ_mass / cp_mass
    du .= vcat(Ydot, Tdot)
end

[jiweiqi]

@RSuryaNarayan BTW, it seems that .svg can not be correctly displayed on the website. You may try .png next time.

[RSuryaNarayan]

Ah sorry for these bugs @jiweiqi shall correct them next time

[RSuryaNarayan]

@jiweiqi the PNG doesn't render in the preview of the markdown for some reason. I have committed it nonetheless. Pls check the new PR

[jiweiqi]

I think the PNG file generated has something wrong. You can see an example here https://github.com/DENG-MIT/Arrhenius.jl/blob/main/docs/src/figures/schem.png.

[RSuryaNarayan]

Aha no @jiweiqi that is not the problem. I meant the PNG file itself doesn't render as an image after I upload it.

[jiweiqi]

Oh, it is alright. We can fix it later. Can you show me the code you used to save the plot to a file in Julia.

[jiweiqi]

I was using this one png(pltsum, "JP10_pyrolysis.png"). This should give a png file. It seems the file you uploaded is still in svg format.

[RSuryaNarayan]

@jiweiqi I seem to have used the right format now. It still doesn't render ryt?

[jiweiqi]

@RSuryaNarayan I just fixed it by changing the file path as ![](./figures/JP10.png).