Skip to content

Commit eb5a381

Browse files
committed
Finish
1 parent 0699079 commit eb5a381

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

docs/index.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,7 @@ Writing mathematical specifications can be a difficult process, especially when
3737
## How does MSML work?
3838

3939

40-
```mermaid
41-
graph TD
42-
A[JSON Object \n\n Each spec has a repo for tracking changes \n Must conform to the json specification \n Defines all aspects of the spec including blocks, spaces and actions] -->B[MSML Object \n\n JSON file is parsed, with validations and mappings along the way \n Can show different views on the fly]
43-
B --> C[Report Outputs & Obsidian Directory \n\n Automatically build reports for the full spec or subviews \n Example: all blocks with an effect on variable XYZ\n Also builds an entire Obsidian directory of all components as linked notes]
44-
D[Python Function Implementations \n\n Optional enhancement to actually execute code\n Done for each referenced policy option, mechanism, etc. \n Just needs a function definition for each] --> B
45-
B --> E[Python Wirings & Simulations \n\n MSML can be used to run blocks \n Wirings automatically work to pass between domain/codomains \n Entire simulations can be built up as composed wirings]
46-
```
40+
![mermaid](mermaid.png)
4741

4842
## MSML in the Engineering Lifecycle
4943

docs/mermaid.png

767 KB
Loading

research_notes/WIP V0.4 Update.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ A total of XX issues were closed out over the development cycle, which broadly f
1919
- State and parameter preparation function paradigms were added into MSML to allow for setting up parameters and state prior to simulations / executable codes
2020
- Metrics were added into implementations to allow for mapping code to them
2121
- Functionality was added in for linking source code to the blocks for easy viewing and writing into markdown reports; as well a source code printing function was added
22+
- An enhanced version of the components running was created which acts as a wrapper around executable code and checks things like the actual spaces match even when doing the code execution side
2223

2324
### Metaprogramming
2425

@@ -31,6 +32,7 @@ A total of XX issues were closed out over the development cycle, which broadly f
3132
- Post-processing function paradigm was added into the mini-simulation runner
3233
- Metric functions were added to the runner for post processing of data
3334
- Ability to run lists of blocks built out
35+
- Mapping of parameter changes to columns for experiments was added in
3436

3537
### Canonical Examples
3638

@@ -46,6 +48,10 @@ A total of XX issues were closed out over the development cycle, which broadly f
4648
- A research note on parameter class names and different ways that it could be implemented (plan is for a "bring your own ontology" approach moving forward)
4749
- Development note on working through an issue with Latex escape characters
4850
- Development research note for future proposals of changes to MSML
51+
- Predator-Prey-Ideation through reverse engineering research note
52+
- Multi-processing research note for aiding with cadCAD performance (and eventual dogfooding on MSML)
53+
- V0.5 release plan was created
54+
- V0.4 update note was created
4955

5056
## Improvements and Convenience Functions
5157

@@ -56,6 +62,15 @@ A total of XX issues were closed out over the development cycle, which broadly f
5662
- Improvements of assertions
5763
- An automatic README writer was added in
5864
- A functionality that automatically writes issues from an MSML scaffold into a github issues was built out
65+
- Large amount of small updates to the reporting sections
66+
- Functionality was added which puts the actual bound code into the markdown reports and also adds links to both the definitions of code as well as the spec component definitions for making it easier to develop
67+
- Depth of 1 mermaid wiring charts were created to make it cleaner to look at different wirings
68+
- The nodes in mermaid graphics are now clickable and bring you to the Obsidian note for that component
69+
- Automated github table creation functionality for project management improvement
70+
- Full issue inventory and tagging of all 200 issues within the MSML repository
71+
- The remove starter repo functionality was refactored for the new MSML template
72+
- The official [MSML documentation](https://blockscience.github.io/MSML/) has been launched
73+
- A getting started guide was built
5974

6075
## Presentations
6176

0 commit comments

Comments
 (0)