Merge pull request #116 from BlockScience/docxs

Docs

Author: SeanMcOwen

.gitmodules

@@ -1,3 +1,12 @@
 [submodule "src/bdp_lib/schemas"]
 	path = src/bdp_lib/schemas
 	url = https://github.com/BlockScience/bdp-schema.git
+[submodule "clients/pybdp"]
+	path = clients/pybdp
+	url = https://github.com/BlockScience/pybdp.git
+[submodule "clients/bdp-typescript"]
+	path = clients/bdp-typescript
+	url = https://github.com/BlockScience/bdp-typescript.git
+[submodule "front-ends/bdp-frontend"]
+	path = front-ends/bdp-frontend
+	url = https://github.com/BlockScience/bdp-frontend.git

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 BlockScience
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

clients/bdp-typescript

@@ -4,30 +4,30 @@ nav_order: 6
 layout: default
 ---
 
-## Toy Models (WORK IN PROGRESS NOT READY)
+- There are numerous toy examples and full canonical examples for illustrating how to get started with the block diagram protocol
 
-### 1. Simple Dynamical System Plant
-- **Description**: A basic model demonstrating a single processor with a feedback loop.
-- **Model JSON**: [simple_model.json](models/simple_model.json)
+## Toy Models
 
-### 2. Closed-Loop Control System
-- **Description**: A model illustrating a closed-loop control system with a plant, controller, and sensor.
-- **Model JSON**: [control_loop_model.json](models/control_loop_model.json)
+- The overall repository hosting the toy models can be found [here](https://github.com/BlockScience/bdp-toy-examples)
 
-### 3. Two-Player Game Model
-- **Description**: A model representing a two-player game with strategies and payoffs.
-- **Model JSON**: [game_model.json](models/game_model.json)
+### Composite Processor Mini Example
 
-### 4. Adaptive Strategy Model
-- **Description**: This model introduces an adaptive strategy where the decision-making process incorporates learning from past experiences to refine the policy over time.
-- **Model JSON**: [adaptive_strategy.json](models/adaptive_strategy.json)
+- A simple example which shows how to build up to a composite processor but with a small model
+- The notebook can be found [here](https://github.com/BlockScience/bdp-toy-examples/blob/main/Composite%20Processor%20Mini/Composite%20Process%20Mini.ipynb)
 
-### 5. Iterated Game with Learning
-- **Description**: An extension of the two-player game model where both players employ adaptive strategies, allowing them to learn and evolve their strategies over multiple iterations.
-- **Model JSON**: [iterated_game_with_learning.json](models/iterated_game_with_learning.json)
+### Composite Processor Example
 
-## Full Models
+- An example of building up a composite processor with a larger subsystem
+- The notebook can be found [here](https://github.com/BlockScience/bdp-toy-examples/blob/main/Composite%20Processor%20Mini/Composite%20Process%20Mini.ipynb)
 
-- Placeholder for future full models represented in separate repositories
-1. Homicidal Chauffeur
-2. KOI?
+### Dynamical Systems
+
+- An example of how a saved JSON file can be loaded and used to display five different versions of dynamical systems
+- The notebook can be found [here](https://github.com/BlockScience/bdp-toy-examples/blob/main/Dynamical%20Systems/Dynamical%20Systems.ipynb)
+
+## Full Canonical examples
+
+### Homicidal Chauffeur (Work in Progress)
+
+- A canonical example based on the classic "Homicidal Chauffeur" problem
+- The repository can be found [here](https://github.com/BlockScience/homicidal-chauffeur-canonical-example)

clients/pybdp

@@ -5,4 +5,6 @@ layout: default
 parent: Functions & Validation Rules
 ---
 
-# Block Functions
+# Block Functions
+
+- Currently no specific block functions

docs/Canonical Examples.md

@@ -24,6 +24,17 @@ class Processor:
         return self.subsystem is None
 ```
 
+### TypeScript Implementation
+
+```typescript
+class Processor {
+    ...
+    isPrimitive(): boolean {
+        return this.subsystem === null;
+    }
+}
+```
+
 ## Get System  
 
 $$\text{getSystem}: \text{Processor} \rightarrow \text{System}$$  
@@ -45,6 +56,20 @@ class Processor:
             return self.subsystem
 ```
 
+### TypeScript Implementation
+
+```typescript
+class Processor {
+    ...
+    getSystem(): any {
+        if (this.isPrimitive()) {
+            return null;
+        } else {
+            return this.subsystem;
+        }
+    }
+}
+```
 
 ## Get Shape
 
@@ -61,4 +86,15 @@ class Processor:
     ...
     def get_shape(self):
         return self.parent
+```
+
+### TypeScript Implementation
+
+```typescript
+class Processor {
+    ...
+    getShape(): Block {
+        return this.parent;
+    }
+}
 ```

docs/Functions & Validation Rules/Block Functions.md

@@ -5,4 +5,6 @@ layout: default
 parent: Functions & Validation Rules
 ---
 
-# Space Functions
+# Space Functions
+
+- No space functions currently