Skip to content

Comments

UsersGuide package#21

Merged
AtiyahElsheikh merged 24 commits intoOpenModelica:developfrom
AtiyahElsheikh:UserGuide
Apr 7, 2021
Merged

UsersGuide package#21
AtiyahElsheikh merged 24 commits intoOpenModelica:developfrom
AtiyahElsheikh:UserGuide

Conversation

@AtiyahElsheikh
Copy link
Collaborator

An initial package for UsersGuide following common guidelines. I have simply moved existing documentation to the UsersGuide package

AtiyahElsheikh and others added 20 commits July 1, 2020 13:55
Usage of MSL 4.0.0 after applying the conversion script
The Modelica grammar does not allow annotations except at the end of a class.
* Convert to MSL 4.0.0

* Update version number to 1.0.3
# Conflicts:
#	BioChem/Interfaces/Reactions/Basics/FourSubstrates.mo
#	BioChem/Units/package.mo
@AtiyahElsheikh AtiyahElsheikh requested a review from sjoelund April 7, 2021 05:35
@AtiyahElsheikh
Copy link
Collaborator Author

Sorry for the high number of commits. Only the last two commits can be considered for review. The other commits are due to merging from previous pull requests.

class CopyRight
extends Modelica.Icons.Information;
annotation(
Documentation(info = "<html><head></head><body>Copyright © 2005-2015 MathCore Engineering AB, Linköpings universitet and Modelica Association</body></html>"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could probably bump that to 2021 and add your own name

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and have added your name as well under ReleaseNotes

class References
extends Modelica.Icons.References;
annotation(
Documentation(info = "<html><head></head><body><h2>References</h2><p><b>BioChem - A Biological and Chemical Library for Modelica (Conference paper)</b><br>Emma Larsdotter Nilsson, Peter Fritzson. Proceedings of the 3rd International Modelica Conference (November 3-4, Linköping, Sweden) 2003, pp. 215-220&nbsp;<br><br><b>A minimal cascade model for the mitotic oscillator involving cyclin and cdc2 kinase</b><br>Albert Goldbeter. Proc. Nati. Acad. Sci. USA Vol. 88, pp. 9107-9111, October 1991 Cell Biology&nbsp;<br><br><b>Hierarchical modeling of diabetes</b><br>Elin Nyman. ISRN:LiU-IKE-EX-09/14. Linköping University 2009.&nbsp;<br><br><b>A Minimal Generic Model of Bacteria-Induced Intracellular Ca<sup>2+</sup>&nbsp;Oscillations in Epithelial Cells</b><br>Camilla Oxhamre, Agneta Richter-Dahlfors, Vladimir P. Zhdanov, and Bengt Kasemo. Biophysical Journal Volume 88 April 2005 2976-2981.&nbsp;<br><br><b>A mathematical model of metabolic insulin signaling.</b><br>A. Sedaghat, R, A. Sherman, and J. Quon, Michael. American Journal of Physiology - Endocrinology and Metabolism, 283:1048-1101, Jul 2002.&nbsp;<br><br><b>Modeling the cell division cycle: cdc2 and cyclin interactions</b><br>John J. Tyson. Proc. Nati. Acad. Sci. USA Vol. 88, pp. 7328-7332, August 1991 Cell Biology&nbsp;<br><br><b>Modeling Feedback Loops of the Mammalian Circadian Oscillator</b><br>Becker-Weimann S, Wolf J, Herzel H, Kramer A. Biophysical Journal Volume 87 November 2004 3023-3034&nbsp;</p></body></html>"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it's HTML, perhaps add links to the papers while changing things?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@AtiyahElsheikh AtiyahElsheikh linked an issue Apr 7, 2021 that may be closed by this pull request
extends Modelica.Icons.References;
annotation(
Documentation(info = "<html><head></head><body><h2>References</h2><p><b>BioChem - A Biological and Chemical Library for Modelica (Conference paper)</b><br>Emma Larsdotter Nilsson, Peter Fritzson. Proceedings of the 3rd International Modelica Conference (November 3-4, Linköping, Sweden) 2003, pp. 215-220&nbsp;<br><br><b>A minimal cascade model for the mitotic oscillator involving cyclin and cdc2 kinase</b><br>Albert Goldbeter. Proc. Nati. Acad. Sci. USA Vol. 88, pp. 9107-9111, October 1991 Cell Biology&nbsp;<br><br><b>Hierarchical modeling of diabetes</b><br>Elin Nyman. ISRN:LiU-IKE-EX-09/14. Linköping University 2009.&nbsp;<br><br><b>A Minimal Generic Model of Bacteria-Induced Intracellular Ca<sup>2+</sup>&nbsp;Oscillations in Epithelial Cells</b><br>Camilla Oxhamre, Agneta Richter-Dahlfors, Vladimir P. Zhdanov, and Bengt Kasemo. Biophysical Journal Volume 88 April 2005 2976-2981.&nbsp;<br><br><b>A mathematical model of metabolic insulin signaling.</b><br>A. Sedaghat, R, A. Sherman, and J. Quon, Michael. American Journal of Physiology - Endocrinology and Metabolism, 283:1048-1101, Jul 2002.&nbsp;<br><br><b>Modeling the cell division cycle: cdc2 and cyclin interactions</b><br>John J. Tyson. Proc. Nati. Acad. Sci. USA Vol. 88, pp. 7328-7332, August 1991 Cell Biology&nbsp;<br><br><b>Modeling Feedback Loops of the Mammalian Circadian Oscillator</b><br>Becker-Weimann S, Wolf J, Herzel H, Kramer A. Biophysical Journal Volume 87 November 2004 3023-3034&nbsp;</p></body></html>"));
Documentation(info = "<html><head></head><body><h2>References</h2><p><b>BioChem - A Biological and Chemical Library for Modelica&nbsp;</b><br>Emma Larsdotter Nilsson, Peter Fritzson. Proceedings of the 3rd International Modelica Conference (November 3-4, Linköping, Sweden) 2003, pp. 215-220&nbsp;<b>(<a href=\"https://www.researchgate.net/publication/237321637_BioChem_-_A_Biological_and_Chemical_Library_for_Modelica\">link</a>)</b><br><br><b>A minimal cascade model for the mitotic oscillator involving cyclin and cdc2 kinase&nbsp;</b><br>Albert Goldbeter. Proc. Nati. Acad. Sci. USA Vol. 88, pp. 9107-9111, October 1991 Cell Biology (<a href=\"https://www.ncbi.nlm.nih.gov/pmc/articles/PMC52661/\">link</a>)&nbsp;<br><br><b>Hierarchical modeling of diabetes</b><br>Elin Nyman. ISRN:LiU-IKE-EX-09/14. Linköping University 2009 (<a href=\"http://liu.diva-portal.org/smash/record.jsf?pid=diva2%3A231708&amp;dswid=mainwindow\">link</a>)<br><br><b>A Minimal Generic Model of Bacteria-Induced Intracellular Ca<sup>2+</sup>&nbsp;Oscillations in Epithelial Cells</b><br>Camilla Oxhamre, Agneta Richter-Dahlfors, Vladimir P. Zhdanov, and Bengt Kasemo. Biophysical Journal Volume 88 April 2005 2976-2981 (<a href=\"https://www.sciencedirect.com/science/article/pii/S000634950573349X\">link</a>)<br><br><b>A mathematical model of metabolic insulin signaling.</b><br>A. Sedaghat, R, A. Sherman, and J. Quon, Michael. American Journal of Physiology - Endocrinology and Metabolism, 283:1048-1101, Jul 2002 (<a href=\"https://pubmed.ncbi.nlm.nih.gov/12376338/\">link</a>)<br><br><b>Modeling the cell division cycle: cdc2 and cyclin interactions&nbsp;</b><br>John J. Tyson. Proc. Nati. Acad. Sci. USA Vol. 88, pp. 7328-7332, August 1991 Cell Biology&nbsp;<b>(<a href=\"https://pubmed.ncbi.nlm.nih.gov/1831270/\">link</a>)</b><br><br><b>Modeling Feedback Loops of the Mammalian Circadian Oscillator&nbsp;</b><br>Becker-Weimann S, Wolf J, Herzel H, Kramer A. Biophysical Journal Volume 87 November 2004 3023-3034 (<a href=\"https://www.ncbi.nlm.nih.gov/pmc/articles/PMC1304775/\">link</a>)</p></body></html>"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

researchgate? Why not the source? https://www.modelica.org/events/Conference2003/papers/h21_Larsdotter_Nilsson.pdf
And http://urn.kb.se/resolve?urn=urn:nbn:se:liu:diva-19076 is the "permanent link" according to the second URL

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@sjoelund
Copy link
Member

sjoelund commented Apr 7, 2021

Squash and merge will let you combine all commits into one

@AtiyahElsheikh AtiyahElsheikh merged commit 049a864 into OpenModelica:develop Apr 7, 2021
@AtiyahElsheikh AtiyahElsheikh deleted the UserGuide branch April 7, 2021 06:42
AtiyahElsheikh added a commit to AtiyahElsheikh/BioChem that referenced this pull request Apr 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

User Guide seems to be missing

2 participants