Open-Systems-Pharmacology / MoBi

MoBi® is a software tool for multiscale physiological modeling and simulation
Other
29 stars 9 forks source link

MoBi Documentation on Equations #493

Open maalbrec89 opened 4 years ago

maalbrec89 commented 4 years ago

Hello everyone,

I did not found the documentation section for equations last time. Later I found it here: MoBi Documentation/Model Building and Model Components/Working with Formulas where I haven't expected it.

The section "Model Building and Model Components" became so large recently that I suggest splitting it up and providing a whole section on Formulas/Equations.

msevestre commented 4 years ago

Great idea

Hint hint: The documentation is open source https://docs.open-systems-pharmacology.org/how-to-contribute

maalbrec89 commented 4 years ago

I like it and would use this contributing option.

However, I think it is a bigger structural change, which includes the introduction of new pages. I feel a bit uncomfortable doing it and would suggest that someone does it who has more experience with Gitbook.

StephanSchaller commented 4 years ago

@maalbrec89 , maybe you can propose what document structure (pages & subsections you would propose. If agreed, @msevestre could set them up and then you can add the content?

maalbrec89 commented 4 years ago

I looked again. I would basically completely dissolve the chapter "Model Building and Model Components" because it is too generic and thus not easy for people who search sth. Then I would just lift the sections within this document one level up almost as they are:

Then one might combine four remaining sections to the section "Start Values for molecules and Parameters"

or shift the remaining sections

Similar thoughts (maybe too fast) to Setting up a Simulation One might uplift the following sections and call them "Numerics":

I guess it is just because the OSPS has been advanced so much lately that one might rework or outbalance the documentation structure.