Skip to content

Commit

Permalink
Merge pull request #2 from AtiyahElsheikh/develop
Browse files Browse the repository at this point in the history
V1.0.2-alpha
  • Loading branch information
AtiyahElsheikh authored Mar 29, 2021
2 parents ba04d5c + a6ca5df commit 01a9ff8
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ A Modelica library for descriptive modeling of biochemical reaction networks usi

#### Release notes

(29.3.2021) v1.0.2-alpha : MSL 4.0.0

(22.06.2020) v1.0.1-alpha : starting the progress again, MSL 3.2.3

(7.12.2018) v1.0-alpha : Initial implementation containing Biochem-like structure and implementation of Convenience and LinLog kinetics
Expand Down
27 changes: 12 additions & 15 deletions UserGuide/package.mo
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
within GenKinetics;
within GenKinetics;
package UserGuide "user guide"
extends Modelica.Icons.Information;

model Overview
extends Modelica.Icons.Information;
annotation (
Documentation(info="<html>
Documentation(info = "<html>
<h4><span style=\"color: #008000\">About</span></h4>
<p><br><i>GenKinetics</i> contains an implementation of a specific set of reaction kinetics, namely, generalized simplified kinetic formats. It follows many of the guidelines recommended by the <a href=\"https://github.com/OpenModelica/BioChem\">Biochem library</a>. The underlying simplified kinetics formats are represented by generalized structured kinetics formulas suitable for arbitrary biochemical reactions with arbitrary number of substrates, products, inhibitors and activators. In this way, matabolic reaction networks can be easily assembled using a few number of reaction kinetics.</p>
<p><br><b><span style=\"color: #008000;\">Structure of the Library</span></b></p>
Expand Down Expand Up @@ -62,26 +62,24 @@ modelica://GenKinetics.Interfaces.Dynamic.Dimension.ReactionDimension\">GenKinet
model Contributors
extends Modelica.Icons.Information;
annotation (
Documentation(info="<html>
<p>Author: Atiyah Elsheikh </p>
Documentation(info = "<html>
<p>Author: Atiyah Elsheikh, Mathemodca.com </p>
<p>Contact details: <i><a href=\"modelica://GenKinetics.UserGuide.Contact\">GenKinetics.UserGuide.Contact</a></i></p>
</html>"));
end Contributors;

model Contact
extends Modelica.Icons.Contact;
annotation (
Documentation(info="<html>
<p>Atiyah Elsheikh :&nbsp;atiyah.m.g.elsheikh at gmail.com </p>
</html>"));
Documentation(info = "<html><head></head><body><p>Atiyah Elsheikh :&nbsp;atiyah.elsheikh at mathemodica.com</p>
</body></html>"));
end Contact;

model ReleaseNotes
extends Modelica.Icons.ReleaseNotes;
annotation (
Documentation(info="<html>
<p><span style=\"font-family: Verdana; color: #24292e; background-color: #ffffff;\">V1.0-alpha (7.12.2018) : First version containing Biochem-like structure and implementation of Convenience and LinLog kinetics</span></p>
</html>"));
Documentation(info = "<html><head></head><body><p><ul><li><font color=\"#24292e\" face=\"Verdana\">V1.0.1-alpha (22.06.2020) : Restarting , MSL 3.2.3</font></li><li><span style=\"color: rgb(36, 41, 46); font-family: Verdana; background-color: rgb(255, 255, 255);\">V1.0.0-alpha (07.12.2018) : First version containing Biochem-like structure and implementation of Convenience and LinLog kinetics</span></li></ul></p>
</body></html>"));
end ReleaseNotes;

model References
Expand All @@ -91,14 +89,13 @@ modelica://GenKinetics.Interfaces.Dynamic.Dimension.ReactionDimension\">GenKinet
model CopyRight
extends Modelica.Icons.Information;
annotation (
Documentation(info="<html>
<p>Licensed under the Modelica License 2</p>
<p><b><span style=\"font-size: 18pt; color: #aa0000;\">Copyright &copy; &lt;2018&gt;, &lt;Atiyah Elsheikh&gt;.</span></b></p>
Documentation(info = "<html><head></head><body><p>Licensed under the Modelica License 2</p>
<p><b><span style=\"font-size: 18pt; color: #aa0000;\">Copyright © &lt;2018-2020&gt;, &lt;Mathemodica.com&gt;.</span></b></p>
<p><i>This Modelica package is&nbsp;<u>free</u>&nbsp;software and the use is completely at&nbsp;<u>your own risk</u>; it can be redistributed and/or modified under the terms of the Modelica BSD 3-Clause License. For license conditions (including the disclaimer of warranty) see&nbsp;<a href=\"modelica://GenKinetics.UserGuide.License\">Modelica.UsersGuide.License&nbsp;</a></i></p>
</html>"));
</body></html>"));
end CopyRight;


annotation (
Documentation);

end UserGuide;
2 changes: 1 addition & 1 deletion UserGuide/package.order
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Overview
Contributors
Contact
License
ReleaseNotes
References
CopyRight
License
3 changes: 2 additions & 1 deletion package.mo
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@

annotation (
Documentation(info = "<html><head></head><body><p>This package contains an implementation of generalized simplified kinetic formats following the guidelines recommended by the&nbsp;<a href=\"https://modelica.org/publications/papers/2005-05-LarsdotterNilsson-Fritzson-BioMedSim2005-MetabolicModeling.pdf\">Biochem library</a>. Matabolic reaction networks can be easily assembled using a few number of reaction kinetics. Constructed models can also be used for computing parameter sensitivities with little modifications to the used interfaces and by initializing the input Jacobian, i.e. the parameters w.r.t. derivatives are sought.</p><p><br>Licensed under the Modelica License 2</p><p><br>Copyright ©&nbsp;<a href=\"GenKinetics.UserGuide.CopyRight\" style=\"font-size: 12px;\">GenKinetics.UserGuide.CopyRight</a></p><p><i>This Modelica package is&nbsp;<u>free</u>&nbsp;software and the use is completely at&nbsp;<u>your own risk</u>; it can be redistributed and/or modified under the terms of the Modelica License 2. For license conditions (including the disclaimer of warranty) see&nbsp;<a href=\"modelica://Modelica.UsersGuide.ModelicaLicense2\">Modelica.UsersGuide.ModelicaLicense2</a>&nbsp;or visit<a href=\"http://www.modelica.org/licenses/ModelicaLicense2\">http://www.modelica.org/licenses/ModelicaLicense2</a>.</i></p></body></html>"),
uses(Modelica(version = "3.2.3")));
uses(Modelica(version = "4.0.0"),BioChem(version = "1.0.2")),
version = "1.0.2");
end GenKinetics;

0 comments on commit 01a9ff8

Please sign in to comment.