Set up documentation

@RSuryaNarayan

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

@jiweiqi

Sure @jiweiqi ! Shall go through.

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

@RSuryaNarayan

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

@jiweiqi

Sure @jiweiqi I shall send the PR right away

@RSuryaNarayan

@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

@RSuryaNarayan

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

@jiweiqi

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

@jiweiqi

@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

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.

@jiweiqi

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

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.

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.

@jiweiqi

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

@RSuryaNarayan

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

Merge pull request #36 from Subsapce-Lab/nh3/43-residual-ratio

Merge pull request #37 from Subsapce-Lab/nh3/53-counterflow-policy

Navigation Menu

Repository navigation

Set up documentation #36

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Set up documentation #36

Description

Activity

jiweiqi commented on Apr 30, 2021

jiweiqi commented on Apr 30, 2021

jiweiqi commented on May 7, 2021

RSuryaNarayan commented on May 7, 2021

RSuryaNarayan commented on May 9, 2021

jiweiqi commented on May 9, 2021

RSuryaNarayan commented on May 9, 2021

jiweiqi commented on May 9, 2021

jiweiqi commented on May 9, 2021

RSuryaNarayan commented on May 9, 2021

RSuryaNarayan commented on May 9, 2021

jiweiqi commented on May 9, 2021

RSuryaNarayan commented on May 9, 2021

jiweiqi commented on May 9, 2021

jiweiqi commented on May 9, 2021

RSuryaNarayan commented on May 9, 2021

jiweiqi commented on May 9, 2021

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions