Skip to content

Commit 22ec73e

Browse files
Merge pull request #729 from sstsimulator/devel
Automatically Merged using SST Master Branch Merger
2 parents 11977e6 + 31e2c16 commit 22ec73e

File tree

10 files changed

+74
-41
lines changed

10 files changed

+74
-41
lines changed

Makefile.am

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ include $(top_srcdir)/Makefile.common
1313

1414
# Files that should be distributed but are not built.
1515
EXTRA_DIST = LICENSE bootstrap.sh \
16-
developer-sstmacro-14.1.pdf \
17-
manual-sstmacro-14.1.pdf \
16+
developer-sstmacro-15.0.pdf \
17+
manual-sstmacro-15.0.pdf \
1818
pdes-report.pdf \
1919
docs \
2020
share \

configure.ac

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ dnl OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
5050
#-------------------------------------------------
5151

5252
# Version info, used both in library versioning and inside sstmacro.
53-
m4_define([SSTMAC_VERSION_TAG], 14)
54-
m4_define([SSTMAC_SUBVERSION_TAG], 1)
53+
m4_define([SSTMAC_VERSION_TAG], 15)
54+
m4_define([SSTMAC_SUBVERSION_TAG], 0)
5555
m4_define([SSTMAC_SUBSUBVERSION_TAG], 0)
5656

5757
dnl Enable this for releases
Binary file not shown.

docs/developer/developer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ category: SSTDocumentation
55
---
66

77

8-
# SST/macro 14.1: Developer's Reference
8+
# SST/macro 15.0: Developer's Reference
99

1010

1111
![](https://github.com/sstsimulator/sst-macro/blob/devel/docs/developer/figures/sstlogo.png)

docs/developer/developer.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
\newcommand{\inlinecode}[1]{{\lstset{basicstyle=\ttfamily,keywordstyle={},showstringspaces=false}\lstinline$#1$}}
6363
\newcommand{\inlineshell}[1]{{\lstset{basicstyle=\ttfamily,keywordstyle={},showstringspaces=false}\lstinline$#1$}}
6464

65-
\title{SST/macro 14.1: Developer's Reference}
65+
\title{SST/macro 15.0: Developer's Reference}
6666

6767
\author{Sandia National Labs \\ Livermore, CA}
6868

docs/developer/markdown.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
\title{SST/macro 14.1: Developer's Reference}
2+
\title{SST/macro 15.0: Developer's Reference}
33

44
\titlepic{\includegraphics[width=0.3\textwidth]{figures/sstlogo.png}}
55

@@ -12,7 +12,7 @@
1212

1313
\input{intro}
1414
\input{classes}
15-
\input{Connectable}
15+
\input{connectable}
1616
\input{sprockit}
1717
\input{scheduling}
1818
\input{software}

docs/manual/manual.md

Lines changed: 64 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ category: SSTDocumentation
55
---
66

77

8-
# SST/macro 14.1 User's Manual
8+
# SST/macro 15.0 User's Manual
99

1010
![](https://github.com/sstsimulator/sst-macro/blob/devel/docs/manual/figures/sstlogo.png)
1111

@@ -3598,9 +3598,9 @@ The following chapter is organized by parameter namespaces. Tables in each names
35983598

35993599

36003600

3601+
| Name (type) | Default | Allowed | Description |
3602+
|-------------|---------|---------|-------------|
36013603
| Name (type) | Default if not given | Allowed Values | Description |
3602-
|-------------|----------------------|-----------------|-------------|
3603-
| | | | |
36043604

36053605
which lists the possible parameter names, allowed values, and brief descriptions.
36063606
More detailed descriptions of particular parameter values are found in the documentation in previous chapters.
@@ -3655,6 +3655,8 @@ The allowed parameter types are:
36553655
| group\_connections (int) | No default | Positive int | For cascase ir dragonfly, the number of intergroup connections on each switch in a Dragonfly group |
36563656
| redundant (vector of int) | vector of 1's | Positive ints | For Cartesian topologies (hypercube, cascadem, dragonfly, torus) this specifies a bandwidth (redundancy) multiplier for network links in each dimension. |
36573657

3658+
\vspace*{-5cm}
3659+
36583660
### Section 8.3: Namespace "node"<a name="sec_nodeParams"></a>
36593661

36603662

@@ -3778,6 +3780,7 @@ All other parameters can be filled in from `node.nic.injection`.
37783780
| credits (byte length) | No default | | The number of initial credits for the component. Corresponds to an input buffer on another component. In many cases, SST/macro can compute this from other parameters and fill in the value. In some cases, it will be required. |
37793781

37803782

3783+
37813784
#### 8.5.3: Namespace ``switch.link"<a name="subsec_switch_link_Params"></a>
37823785

37833786

@@ -3791,39 +3794,69 @@ All other parameters can be filled in from `node.nic.injection`.
37913794

37923795

37933796

3797+
37943798
### Section 8.6: Namespace "appN"<a name="sec_appN_Params"></a>
37953799

37963800

37973801
This is a series of namespaces `app1`, `app2`, and so on for each of the launched applications. These should be contained within the `node` namespace.
37983802

3799-
3800-
| Name (type) | Default | Allowed | Description |
3801-
|-------------|---------|---------|-------------|
3802-
| name (string) | No default | parsedumpi, cxx\_full\_main, cxx\_empty\_main | The name of the application to launch. Very few applications are built-in. Registration of external apps is shown starting in Section [3.5](#sec_tutorial_basicmpi). |
3803-
| size (int) | No default | Positive int | The number of procs (MPI ranks) to launch. If launch\_cmd given, this parameter is not required. |
3804-
| start (int) | 0 | | The time at which a launch request for the application will be made |
3805-
| concentration (int) | 1 | Positive int | The number of procs (MPI ranks) per compute node |
3806-
| core\_affinities (vector of int) | Empty | | |
3807-
| launch\_cmd (string) | No default | Valid aprun or srun | This uses a launch command as would be found with ALPS or SLURM launchers on real systems, e.g. aprun -n 4 -N 1 |
3808-
| indexing (string) | block | block, random, cart, node\_id, coordinate | The indexing scheme for assign proc ID (MPI rank number) to compute nodes |
3809-
| node\_id\_mapper\_file (filepath) | No default | | If using Node ID indexing, the file containing the node ID index list |
3810-
| random\_indexer\_seed (long) | System time | | The seed to use for a random allocation. If not specified, system time is used. |
3811-
| allocation (string) | first\_available | first\_available, random, cart, node\_id, coordinate | The scheme to use for allocating compute nodes to a given job. |
3812-
| random\_allocation\_seed (long) | System time | | For random allocation policy. If unspecified, system time is used as the seed. |
3813-
| node\_id\_allocation\_file (filepath) | No default | | If using Node ID allocation, the file containing the list of node IDs to allocate for the job |
3814-
| dumpi\_metaname (filepath) | No default | | If running DUMPI trace, the location of the metafile for configuring trace replay |
3815-
| coordinate\_file (filepath) | No default | | If running using coordinate allocation or indexing, the path to the file containing the node coordinates of each proc (MPI rank) |
3816-
| cart\_sizes (vector of int) | No default | | Launch a contiguous block of nodes in a Cartesian topology. This gives the size of each dimension in the block. |
3817-
| cart\_offsets (vector of int) | No default | | Launch a contiguous block nodes in a Cartesian topology. This gives the offset in each dimension where the block begins. |
3818-
| parsedumpi\_timescale (double) | 1.0 | Positive float | If running DUMPI traces, scale compute times by the given value. Values less than 1.0 speed up computation. Values greater than 1.0 slow down computation. |
3819-
| parsedumpi\_terminate\_percent (int) | 100 | 1-100 | Percent of trace. Can be used to terminate large traces early |
3820-
| host\_compute\_timer (bool) | False | | Use the compute time on the host to estimate compute delays |
3821-
| otf2\_metafile (string) | No default | string | The root file of an OTF2 trace. |
3822-
| otf2\_timescale (double) | 1.0 | Positive float | If running OTF2 traces, scale compute times by the given value. Values less than 1.0 speed up computation. Values greater than 1.0 slow down computation. |
3823-
| otf2\_print\_mpi\_calls (bool) | false | | Print MPI calls found in the OTF2 trace |
3824-
| otf2\_print\_trace\_events (bool) | false | | Debugging flag that printsindividual trace events (which includes details such as when an MPI call begins, ends, and when a collective begins and ends |
3825-
| otf2\_print\_time\_deltas (bool) | false | | Debugging flag that prints compute delays injected by the simulator |
3826-
| otf2\_warn\_unknown\_callback (bool) | false | | Debugging flag the prints unknown callbacks |
3803+
\openLongTable
3804+
\hline
3805+
name (string) & No default & parsedumpi, cxx\_full\_main, cxx\_empty\_main & The name of the application to launch. Very few applications are built-in. Registration of external apps is shown starting in Section [3.5](#sec_tutorial_basicmpi). \\
3806+
\hline
3807+
size (int) & No default & Positive int & The number of procs (MPI ranks) to launch. If launch\_cmd given, this parameter is not required. \\
3808+
\hline
3809+
start (int) & 0 & & The time at which a launch request for the application will be made \\
3810+
\hline
3811+
concentration (int) & 1 & Positive int & The number of procs (MPI ranks) per compute node \\
3812+
\hline
3813+
core\_affinities (vector of int) & Empty & & \\
3814+
\hline
3815+
launch\_cmd (string) & No default & Valid aprun or srun & This uses a launch command as would be found with ALPS or SLURM launchers on real systems, e.g. aprun -n 4 -N 1 \\
3816+
\hline
3817+
indexing (string) & block & block, random, cart, node\_id, coordinate & The indexing scheme for assign proc ID (MPI rank number) to compute nodes \\
3818+
\hline
3819+
node\_id\_mapper\_file (filepath) & No default & & If using Node ID indexing, the file containing the node ID index list \\
3820+
\hline
3821+
random\_indexer\_seed (long) & System time & & The seed to use for a random allocation. If not specified, system time is used. \\
3822+
\hline
3823+
allocation (string) & first\_available & first\_available, random, cart, node\_id, coordinate & The scheme to use for allocating compute nodes to a given job. \\
3824+
\hline
3825+
random\_allocation\_seed (long) & System time & & For random allocation policy. If unspecified, system time is used as the seed. \\
3826+
\hline
3827+
node\_id\_allocation\_file (filepath) & No default & & If using Node ID allocation, the file containing the list of node IDs to allocate for the job \\
3828+
\hline
3829+
dumpi\_metaname (filepath) & No default & & If running DUMPI trace, the location of the metafile for configuring trace replay \\
3830+
\hline
3831+
coordinate\_file (filepath) & No default & & If running using coordinate allocation or indexing, the path to the file containing the node coordinates of each proc (MPI rank) \\
3832+
\hline
3833+
cart\_sizes (vector of int) & No default & & Launch a contiguous block of nodes in a Cartesian topology. This gives the size of each dimension in the block. \\
3834+
\hline
3835+
cart\_offsets (vector of int) & No default & & Launch a contiguous block nodes in a Cartesian topology. This gives the offset in each dimension where the block begins. \\
3836+
\hline
3837+
parsedumpi\_timescale (double) & 1.0 & Positive float & If running DUMPI traces, scale compute times by the given value. Values less than 1.0 speed up computation. Values greater than 1.0 slow down computation. \\
3838+
\hline
3839+
parsedumpi\_terminate\_percent (int) & 100 & 1-100 & Percent of trace. Can be used to terminate large traces early \\
3840+
\hline
3841+
host\_compute\_timer (bool) & False & & Use the compute time on the host to estimate compute delays \\
3842+
\hline
3843+
otf2\_metafile (string) & No default & string & The root file of an OTF2 trace. \\
3844+
\hline
3845+
otf2\_timescale (double) & 1.0 & Positive float & If running OTF2 traces, scale compute times by the given value. Values less than 1.0 speed up computation. Values greater than 1.0 slow down computation. \\
3846+
\hline
3847+
otf2\_print\_mpi\_calls (bool) & false & & Print MPI calls found in the OTF2 trace
3848+
\\
3849+
\hline
3850+
otf2\_print\_trace\_events (bool) & false & & Debugging flag that printsindividual trace events (which includes details such as when an MPI call begins, ends, and when a collective begins and ends
3851+
\\
3852+
\hline
3853+
otf2\_print\_time\_deltas (bool) & false & & Debugging flag that prints compute delays injected by the simulator
3854+
\\
3855+
\hline
3856+
otf2\_warn\_unknown\_callback (bool) & false & & Debugging flag the prints unknown callbacks
3857+
\\
3858+
\hline
3859+
\end{tabularx}
38273860

38283861

38293862

docs/manual/manual.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
\pagestyle{empty}
6060

6161

62-
\title{SST/macro 14.1: User's Manual}
62+
\title{SST/macro 15.0: User's Manual}
6363
\titlepic{\includegraphics[width=0.3\textwidth]{figures/sstlogo.png}}
6464
\author{Sandia National Labs \\ Livermore, CA}
6565

docs/manual/markdown.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
\title{SST/macro 14.1 User's Manual}
2+
\title{SST/macro 15.0 User's Manual}
33
\titlepic{\includegraphics[width=0.3\textwidth]{figures/sstlogo.png}}
44

55

Binary file not shown.

0 commit comments

Comments
 (0)