PK-Sim DB docu lacks an introduction section

[georgeDaskalakis]

@Yuri05 I have added a small intro to the DB section. Do you think it is enough, or should it actually be expanded.

[Yuri05]

@georgeDaskalakis Somehow I missed this change in a PR :) Here are some change/extension suggestions:

1. I would extend the 1st sentence to:

============================================================= PK-Sim uses an SQLite database to store:

• structural models for PBPK modeling of small and large molecules
• anatomical and physiological parameters in different animal species and human populations for healthy individuals
  • s. tab_population_disease_states for details regarding parameterization of diseased individuals
• templates for small and large molecules
• templates for optional processes like
  • metabolizing pathways
  • different active transporter types (influx, efflux, bidirectional)
  • protein binding partners
• templates for various administration routes and formulations
• prediction models for
  • tissue partition coefficients
  • cellular permeabilities
  • intestinal permeability
• templates for events (meals etc.)

The database can be found in the PK-Sim repository under src/Db/PKSimDB.sqlite.

=============================================================

2. We could also add a sentence that the diagrams were created using the SchemaCrawler and point to this short wiki: https://github.com/Open-Systems-Pharmacology/developer-docs/wiki/Using-SchemaCrawler-for-creating-of-database-schema-diagrams.

[georgeDaskalakis]

@Yuri05 I have created a PR ( here ) adopting your suggestions.

Do you think I should move the tutorial for the SchemaCrawler from the wiki to the main documentation and add it to the index under the DB things?

[Yuri05]

Do you think I should move the tutorial for the SchemaCrawler from the wiki to the main documentation and add it to the index under the DB things?

As you like - I don't have strong opinion on this :)

[georgeDaskalakis]

@Yuri05 OK, I am leaving it in the wiki for now. It is not exactly what you would call necessary onboarding info for a new developer contributing to OSPSuite, so I think keeping it separate does make sense