Documentation Pull Request

draeger-lab / SBSCL

The Systems Biology Simulation Core Library (SBSCL) provides an efficient and exhaustive Java implementation of methods to interpret the content of models encoded in the Systems Biology Markup Language (SBML) and its numerical solution.

https://draeger-lab.github.io/SBSCL/

GNU Lesser General Public License v3.0

20 stars 13 forks source link

Documentation Pull Request #57

Closed hemilpanchiwala closed 4 years ago

hemilpanchiwala commented 4 years ago

This PR

updates the complete documentation of SBSCL
updates the site files of SBSCL
adds UserGuidelines to use the features of SBSCL
adds sequence diagrams for the developers to understand the workflow of SBSCL
updates README.md

Many small updates have been made with the above-mentioned points in the PR.

shalinshah1993 commented 4 years ago

Some links are missing in dependencies.html page. For example, libkisao, GLPKSolverPack, etc.
In summary.html, there is version 1.5. After the changes should we update at least the minor version?
In the current management.html page, the link points to shalinshah1993's SBSCL version. Great to see you fixed that!
BTW this is also a good chance to update pictures in team page, if anyone wants to add? For example, we can add @zakharc there

Otherwise ...

hemilpanchiwala commented 4 years ago

Some links are missing in dependencies.html page. For example, libkisao, GLPKSolverPack, etc.

@shalinshah1993, the links are generated automatically by the command mvn site. But the links are not generated for the 4 libraries as they are used in maven from the lib folder only (they are present in repository only and others are from maven).

matthiaskoenig commented 4 years ago

Please add the diagrams to the User Guidelines. I don't see the diagrams anywhere displayed. These should be part of the documentation and not only exist in a folder.