Make a architechture diagrams for the whole ChemistryGym Project

[rateldajer]

We need to have some figures to present and document the code for the chemistry gym. This will be a series of easily understandable figures that show the interaction between the classes, modules, functions etc.

Collaboration:

• the manually drawn figures should be edited in a collaborative environment like google draw or lucidchart (we can purchase a license if needed)

Ideas for relevant figures, add more as we come up with them

• Workflow for the "Lab Manager" as an agent, from the point of view a human would understand:
  • obtain materials from storage
  • prepare vessels
  • submit vessels to a bench for processing
  • receive the output from a bench and submit repeat
• Class interaction diagrams:
  • high level just between all the classes with minimal annotation
  • fundamental annotation on the arrows between classes
  • does not need to be proper UML, needs to be useful for a blog post, or presentation
• MDP definitions, for each decision space (lab, each bench, others?)
  • box naming the space
  • inside the box definitions of:
    • states
    • actions
    • rewards
    • dynamics (brief description)
• Proper UML diagram of all the classes and functions
  • this can probably be created automatically

[rateldajer]

Make a couple paper-appropriate diagrams. Unique shapes for each entity in the lab:

• vessel
• benches

with standard inputs/outputs for the objects.

[rateldajer]

https://app.diagrams.net/