Webel::SysML4Mathematica

For an introduction to this ongoing project please visit:
The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering
Most of the Webel IT Australia Policy Note pages for the Webel::SysML4Mathematica modelling and coding recipe have detailed explanations and are linked to examples.

SECTION: The Webel Doc` package and the HelpF`& HelpO` help registry packages

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
Why the Webel HelpF` & HelpO` registries?
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: helpPackage[$pac$HelpF]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
HelpF`: Pull Mathematica Options[] for a function registered with addFunction
HelpF`: general query based help
HelpF`: packageFunctionTree[$pac]: Function ::usage help and signatures within a package
HelpF`: Function search by argument number/kind to aid testing automation (1)
HelpF`: Function search by argument number/kind to aid testing automation (2)
HelpF`: Simple package function DownValues vs ::usage checker
HelpF`: Simple function DownValues inspector GUI: gui$helpDownStrings
HelpF`: gui$helpDownStrings signature display modes
The Webel HelpO`package class and method registry
HelpO`: addClass: Register an MTools class by fully qualified package name
HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
HelpO`: Find help on a method of a Webel MAll universal class object
Using the MFunction and MMethod helper classes with MArg & MOpt
Using the Webel MFunction class and MArg & MOpt with HelpF`
Using the Webel MMethod class and MArg & MOpt with HelpO`
Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
Using the Webel MClass helper with the MMethod helper and the HelpO` help registry
Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries
Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`

SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"
The Webel $opt$ options "help holder" convention
Examples of Webel $opt$ with qualifiers
Webel $opt$ options help by function: Example: tableFunctionOptions[f]
Cleaner Options declarations!
Webel '$arg$' and '$opt$' support via the Doc` package
Functions from the W`Base`Doc` package
Make a Webel option help Rule relying on ‘$opt$’ naming conventions
Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention
Make a Webel help Rule for a required ‘$arg$’ argument + conventions
Make a Webel argument help Rule with a default by convention OR override
Webel $arg$ convention help consistency checks
Webel ‘rule$arg$’ convention help consistency checks
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
When to use explicit $arg$ help holders (in lower level utility packages)
Why not just generate all the '$arg$' and '$opt$' help holders (using ToExpression)?
Why not just use the Entity system for '$arg$' and '$opt$' help holders?
Association vs Class as SysML CASE: Webel $arg$ and $opt$ help
Association as SysML: CASE: Webel @RuleMap and @ArgsMap «pseudo» blocks. Very "fiddly" to represent in a SysML Block Definition Diagram!
Association as SysML: CASE: Webel @ArgMap «pseudo» block (slightly less "fiddly" as an Internal Block Diagram)
Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
Webel ‘$opt$’ help is much easier with the MOpt class using MTools!
Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt!
Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions

SECTION: A brief look at the Webel W`Base` utilities for Mathematica

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
The Webel W`Base`«M:Project» and «M:Paclet»
Overview of Webel utility W`Base` packages as SysMLv1 Blocks
Overview of Webel utilities W`Base` packages as SysML Usages
Detailed overview of Webel utilities W`Base` packages with usages
Webel W`Base` vs Git repository and Wolfram Player Pro encoded version
Some Webel Devel` package functions
Diagnostic message Print output switching between Mathematica and Wolfram Player Pro
The Webel ‘$pac$’ convention and DEVEL loading echo diagnostics
Devel` package: check Function Symbol against ::usage
Devel` functions for ExpressionTree (basic)
Some Webel Utility` package functions
Utility`package: stripOpt and stripOpts Delegating subsets of Options
Some Webel Display` package functions
The Webel ManGUI` package utilities for Manipulate GUIs
The Webel ManGUI` package $man$ option aliases
Webel ManGUI` examples: man$bool and man$group$pane
The Webel W`Moo` package group: Additional utilities for the user-contributed MTools paclet for classes & object orientation
Deployment folders for projects that depend on W`Base` and MTools OO (as SysML)

SECTION: Webel coding and naming conventions for the Wolfram Language

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
DRY not WET! "Don't Repeat Yourself!"
The Webel ‘$’ prefix convention for Strings and "String similar" Wolfram Language code
The Webel $k$ prefix convention for Association String keys
The Webel ‘$pat$’ pattern helper convention for frequently used Patterns
The Webel ‘$t$’ “pseudo type” indicator String convention (for optional additional documentation only)
Webel ‘$info$f$’ prefix convention for function help holder Strings
Webel ‘def$’ DRY default capture! Applicable to arguments and options.

SECTION: Modelling the Wolfram Language in SysMLv1 and related Webel coding conventions

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
Modelling the Wolfram Language in SysML and SysML-friendly coding conventions.
Basic SysMLv1 example: The HelpM` package MTools classes as Blocks
SysML Stereotypes and icons used for Mathematica and Wolfram technologies
Wolfram Language vs SysMLv1
Parameter types in most SysML tools
Explicit vs implicit representation of expressions in SysML4Mathematica
Webel SysML4Mathematica: Some Wolfram Language Heads as SysMLv1 Blocks and ValueTypes
Concise {} for List and <||> for Association
Frequently used typed {} Lists
Frequently used String pair Lists
Association <||> vs Rule
Typed Association example: <||>$* maps String to any expression
“Active” OpaqueBehaviors corresponding to block Heads: Used in CallBehaviorActions
“Chained” Head and OpaqueBehavior Convenient for frequently used combinations
Example: Representation of a Webel MAll class MTools method as a SysML Activity Diagram
SysML Activities as function networks (simple contrived Real maths example)
SysML/UML ExpansionRegion for iteration (as adapted for use with Mathematica)
SysML Activity with @pseudo functions capturing Wolfram Language logic
The sigsUp/Down functions as a SysML BDD: With Options Block and pseudo functional indicators
The sigsUp function with OptionsPattern modelled as a SysML Activity (and with "pseudo functional" representation)
Extract Options from an OptionsPattern[] in a SysML Activity (1)
Extract Options from an OptionsPattern[] in a SysML Activity (2) DETAILED
About «pseudo» blocks (always prefixed with ‘@’)

SECTION: The Webel Mathematica libraries - INTRODUCTION - And the role of SysML

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
DISCLAIMERS & CONCERNING TRADEMARKS
About the author
About this slide set
About use of Wolfram Language code
About use of SysML Diagrams
A word on classes and object orientation for Mathematica
Representing the SysMLv1 Block and SysMLv2 Part Def in Mathematica requires classes and object orientation (OO)
SysMLv1 vs SysMLv2
Main topics & sections
HOW not WHAT!
It’s rather technical!

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Jump to first slide
DISCLAIMERS & CONCERNING TRADEMARKS
SECTION: The Webel Mathematica libraries - INTRODUCTION - And the role of SysML
SECTION: Modelling the Wolfram Language in SysMLv1 and related Webel coding conventions
SECTION: Webel coding and naming conventions for the Wolfram Language
SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language
SECTION: A brief look at the Webel W`Base` utilities for Mathematica
SECTION: The Webel Doc` package and the HelpF`& HelpO` help registry packages
SECTION: The Webel Var` package Entity-based variable registry
Subscribe to Webel::SysML4Mathematica
© Copyright 2000 - 2024 Webel IT Australia (WEBEL.COM.AU) (ABN 67 677 268 579). All rights reserved.
Excluded: Text from OMG™ specifications parsed into UML™ and SysML™ analysis models remains © Copyright The Object Management Group™.
Excluded: Text from Wikipedia articles quoted for educational purposes is subject to the Wikipedia Creative Commons Attribution ShareAlike Licence
Excluded: Text from Java™ tutorials and documentation - parsed into UML™ analysis models - remains © Copyright Oracle
UML® is a registered trademark of the Object Management Group.
SysML® is a registered trademark of the Object Management Group.
OMG® is a registered trademark of the Object Management Group.