Skip to content

Commit

Permalink
Add a summary of recipes in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
manasbajaj authored Jun 18, 2022
1 parent 41d4710 commit 444772b
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,17 @@
The SysML v2 API Cookbook repository is a collection of API recipes to demonstrate patterns and examples for using the [SysML v2 API & Services](https://github.com/Systems-Modeling/SysML-v2-API-Services).

In the current release, the cookbook contains recipes that use the SysML v2 REST/HTTP API (PSM). Each recipe is a [Jupyter notebook](https://jupyter.org/) with a sequence of API calls to the SysML v2 REST/HTTP API.

## Description of recipes

### Requirement, Structure, Behavior decomposition recipe
This recipe shows patterns and examples for navigating the decomposition of requirements, structure, and behavior elements using the SysML v2 API. The SysML v2 meta-model has harmonized the concepts related to element decomposition and the same concepts are used when decomposing requirements, structure, and behavior releated elements. This recipe shows the use of a common recursive function to navigate the decomposition of requirements, structure, and behavior elements.

See the Jupyter notebook Req_Str_Beh_Decomposition_Recipe.ipynb for details.

### Project, Commit, Branch, and Tag recipe
This recipe shows patterns and examples for fetching and creating commits, branches, and tags in a project. It shows an example scenario for SysML v2 project evolution over time with concurrent users working on different branches, creating new commits, and creating tags for baseline or milestone releases of the project.

See the Jupyter notebook Project_Commit_Branch_Tag_Recipe.ipynb for details.


0 comments on commit 444772b

Please sign in to comment.