Skip to content

Commit b2b8426

Browse files
committed
Add FAQ
1 parent 71f21be commit b2b8426

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

docs/FAQ.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,36 @@ layout: page
44
nav_order: 5
55
---
66

7-
FAQs
7+
The following are frequently asked questions with regards to MSML.
8+
9+
## What structure or paradigm is MSML based off of?
10+
11+
- The structure is based off of Generalzied Dynamical Systems but with some semantic additions mainly coming out of past specs that were built at BlockScience
12+
- This, however, may soon change to be an ontology based version where there is the super class of "Block" and then users bring their own ontologies instead of having blocks defined out as boundary actions, control actions, policies, mechanisms and wirings
13+
14+
## What are the capabilities of MSML?
15+
16+
- Writing a spec that has automated reporting attached to it in the form of an obsidian vault
17+
- Binding code and trying out running blocks of logic
18+
- Mini simulations
19+
- Future capabilities that are in flight including more reporting styles, meta-programming to cadCAD, bigger simulation running and canonical examples
20+
21+
## What deliverables can MSML produce?
22+
23+
- The short answer is the main deliverables can be seen in the [MSML template](https://github.com/BlockScience/MSML-Template), otherwise below are some of the main deliverables
24+
- Obsidian vault creation for internal development in the beginning and then eventually easily interfacing with clients, markdown files are created for every component for easily zooming in and out of the system
25+
- Notebooks and paradigms for internal dev of testing and playgrounds for testing out bound code on specs
26+
- Single simulation and simulation sweep notebooks for creating interfaces that clients can easily modify for running their own experiments as well as setting up experiment notebooks for client deliverables
27+
28+
## What is the difference between MSML and cadCAD?
29+
30+
- The underlying paradigm of GDS is the same but right now cadCAD only does the general block approach and not the semantic enhancements of things like boundary action, but because all the blocks in MSML are still the same block base class they all will function the same in cadCAD
31+
- Spaces are the same (but with respect to cadCAD 1.0 and not cadCAD legacy)
32+
- cadCAD should be for running large scale simulations optimized for speed, versus MSML can be used for scaffolding
33+
- MSML should be better suited for ideation and working through “bread-boarding” before moving on to a stricter paradigm of cadCAD for more optimized simulations
34+
35+
36+
## What level of customization does MSML provide?
37+
38+
- The actual writing of specs is very flexible as one can encode nearly anything into them
39+
- There are future issues to tackle on expanding the customizability of reporting outputs

0 commit comments

Comments
 (0)