Skip to content

Commit da08ec1

Browse files
committed
Editorial changes to the first group of math libraries entries
1 parent 29c3468 commit da08ec1

File tree

8 files changed

+182
-56
lines changed

8 files changed

+182
-56
lines changed

_data/icon-map.yml

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,34 @@
1414
icon: <i class="fa-solid fa-file-arrow-down"></i>
1515
- label: Documentation
1616
icon: <i class="fa-regular fa-file-lines"></i>
17+
- label: User guide
18+
icon: <i class="fa-regular fa-file-lines"></i>
19+
- label: User's guide
20+
icon: <i class="fa-regular fa-file-lines"></i>
21+
- label: Contributor guide
22+
icon: <i class="fa-regular fa-file-lines"></i>
23+
- label: Contributor's guide
24+
icon: <i class="fa-regular fa-file-lines"></i>
25+
- label: How-to articles
26+
icon: <i class="fa-regular fa-file-lines"></i>
27+
- label: Examples
28+
icon: <i class="fa-regular fa-file-code"></i>
29+
- label: Videos
30+
icon: <i class="fa-solid fa-video"></i>
31+
- label: Tutorials
32+
icon: <i class="fa-solid fa-person-chalkboard"></i>
33+
- label: Workshop
34+
icon: <i class="fa-solid fa-users-line"></i>
35+
- label: Seminars
36+
icon: <i class="fa-solid fa-person-chalkboard"></i>
37+
- label: Mailing list
38+
icon: <i class="fas fa-envelope"></i>
39+
- label: Mailing lists
40+
icon: <i class="fas fa-envelope"></i>
41+
- label: Discord
42+
icon: <i class="fa-brands fa-discord"></i>
43+
- label: Issue tracker
44+
icon: <i class="fa-solid fa-list-check"></i>
1745
#
1846
# Also use this structure to uniformly lookup icons used
1947
# elsewhere on the site (i.e. not in resource link lists)
@@ -52,7 +80,6 @@
5280
#
5381
# Info sheet
5482
# Blog
55-
# Mailing list(s)
5683
# Support (life preserver)
5784
# Issue tracker(s) (checklist)
5885
# Quickstart
@@ -68,5 +95,4 @@
6895
# Tutorial(s) (is this just Documentation?)
6996
# Social channels (Maybe MM theme has many of these already? RSS, X/Twitter, LinkedIn, Instagram, TickTok, Bluesky, Mastadon, Facebook, YouTube channel, Slack, ...?)
7097
# Relevant standards (???)
71-
# Contributor guide
7298
# Maintainer(s) (maybe not resource links, maybe internal to the md file rather than public?)

_sw/amrex.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@
4141
# left margin. The value ends at the next outdented text (or comment).
4242
#
4343
name: AMReX
44-
area: Co-design
44+
area: mathlibs # Original submission: Co-design
4545
cass_member: FASTMath
46-
description: Software Framework for Block Structured AMR
46+
description: Software framework for block structured AMR
4747
long_description: |
4848
AMReX is a C++-based software framework that supports the development of
4949
structured mesh algorithms for solving systems of partial differential

_sw/ginkgo.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -86,27 +86,6 @@ spack_name: ginkgo
8686
#
8787
# For additional information, see _sw/README.md.
8888
#
89-
# additional_resource_links:
90-
# - label: Website
91-
# url:
92-
# - label: Repository
93-
# url:
94-
# - label: Downloads
95-
# url:
96-
# - label: Documentation
97-
# url:
98-
#
99-
# A set of resources specifically aimed at users of the software (OPTIONAL)
100-
#
101-
# end_user_resource_links:
102-
# - label:
103-
# url:
104-
#
105-
# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)
106-
#
107-
# developer_resource_links:
108-
# - label:
109-
# url:
11089
additional_resource_links:
11190
- label: Website
11291
url: https://ginkgo-project.github.io
@@ -117,5 +96,4 @@ additional_resource_links:
11796
end_user_resource_links:
11897
- label: User guide
11998
url: https://github.com/ginkgo-project/ginkgo/wiki
120-
icon: fa-solid fa-circle-info
12199
---

_sw/hypre.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ additional_resource_links:
105105
# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)
106106
#
107107
developer_resource_links:
108-
- label:
108+
- label: Documentation
109+
note: for developers
109110
url: https://github.com/hypre-space/hypre/wiki
110111
---

_sw/magma.md

Lines changed: 118 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,118 @@
1-
---# Product information for CASS website product catalog## INSTRUCTIONS# This is a Jekyll Markdown file, which starts with YAML "frontmatter." For the product# catalog, we will be using only the YAML frontmatter (between the "---" seperators).# Please leave the main body empty.## Please name the file itself for the software product: <name>.md (all lowercase)## We've tried to require the minimum, but anything optional you choose to add will enrich your# product's entry in the catalog. To provide optional items, please uncomment the keys and complete# the value appropriately.## Please see the accompanying README.md for more detailed information and guidance.## BASIC PRODUCT INFORMATION (ALL REQUIRED)# name: (string) REQUIRED The name under which your product should appear in the catalog# area: (string) REQUIRED The technical area of the product. For now, we are using# the areas that were used by ECP ST, except that anything that was categorized as# NNSA Software under ECP should instead be listed under the appropriate "real" area:# Values include: "dataviz", "devtools", "mathlibs", "pmr", "sweco".# We also support the values used in e4s.yml files, though we prefer those above.# cass_member: (string) REQUIRED The name of the CASS member organization (aka software stewardship# organization) you are associated with. Values include: "FASTMath", "PEOS", "RAPIDS", "S4PST", "STEP".# (other CASS members are not stewarding software products, as far as we know: COLABS, CORSA, SWAS)# description: (string) REQUIRED A short description of your software. The `description` is always shown immediately# after the `name` and they should be considered together as, in effect constructing a sentence-length# description of the product with the form `name: desciption`. However it does not need to be a complete# sentence in the grammatical sense. Key points: The `description` should *not* repeat the `name`, it# should be in sentence case, and it should *not* end with a period.# long_description: (multiline string) REQUIRED A one-paragraph description of your software. A brief, moderately technical description# of your software's primary features and capabilities.# target_audience: (multiline string) REQUIRED A one-paragraph description of who should be interested in your software. This should be# less technical than the description -- meant to guide someone who's inexpert or just trying to# figure out who might be using the software.## Note on multline string entries (long_description and target_audience): YAML supports a multiline string entry that allows# a value to be a paragraph (or several). A multiline string value starts with a pipe ("|") following the colon of the key, with# the text of the value starting on the following line. The entirety of the value should be indented by 2-4 spaces from the# left margin. The value ends at the next outdented text (or comment).#name: MAGMAarea: mathlibscass_member: FASTMathdescription: Matrix Algebra on GPUs and Multicore Architectures is a library for BLAS and LAPACK on GPUs.long_description: | MAGMA is a node-level mathematical library for dense linear algebra algorithms on GPU-accelerated HPC systems. MAGMA provides BLAS, batch BLAS, LAPACK, and batch LAPACK functionality on NVIDIA, AMD, and Intel GPUs, often complementing the industrial numerical libraries. MAGMA pioneered hybrid CPU-GPU algorithms for dense matrix factorizations, linear solvers, eigenvalue, and singular value decompositions. MAGMA has been partially adopted by NVIDIA and AMD into their numerical linear algebra libraries. It is an integral component of many DOE applications, and is part of xSDK and E4S.target_audience: | Computational scientists from various domains, numerical analysts, HPC scientists, certain AI applications, developers of other math libraries such as Finite elements analysis, sparse direct solvers, computational statistics, computer vision, and others.## PACKAGING INFORMATION# This information is used to connect your product with its E4S and Spack packages, if available.# e4s_product: (string) If your product is in E4S, list its e4S name here (may be different than `name`). If your# product is not in E4S, comment out this entry.# spack_name: (string) The name of your spack package(s), if available. If you don't have a Spack package, comment out this# entry. If your product has multiple Spack packages, list them using YAML list syntax:# spack_name:# - package1# - package2# - package3#e4s_product: MAGMAspack_name: magma## ADDITIONAL PRODUCT INFORMATION# These are OPTIONAL lists of resource links that you can provide to make your catalog entry more useful.# The typical set includes: Website, Repository, Downloads, and Documentation, but all of these are optional, and# you can also add other labels. `additional_resource_links` is a general category; `end_user_resource_links` and# `developer_resource_links` are meant to target the named groups more specifically. Use them as you like.## The essential inputs are structured as follows:# - label: Resource label # REQUIRED# url: https://example.com # REQUIRED# note: (additional info) # OPTIONAL# icon: fa-solid fa-font-awesome # OPTIONAL, a FontAwesome icon identifier## Which would appear as (in pseudo-markdown):# {{ icon }} [{{ label }}]({{ url }}) {{ note }}## For additional information, see _sw/README.md.## additional_resource_links:# - label: Website# url:# - label: Repository# url:# - label: Downloads# url:# - label: Documentation# url:## A set of resources specifically aimed at users of the software (OPTIONAL)## end_user_resource_links:# - label:# url:## A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)## developer_resource_links:# - label:# url:additional_resource_links: - label: Website url: https://icl.utk.edu/magma - label: Repository url: https://github.com/icl-utk-edu/magma - label: Documentation url: https://icl.utk.edu/projectsfiles/magma/doxygen/index.html---
1+
---
2+
# Product information for CASS website product catalog
3+
#
4+
# INSTRUCTIONS
5+
# This is a Jekyll Markdown file, which starts with YAML "frontmatter." For the product
6+
# catalog, we will be using only the YAML frontmatter (between the "---" seperators).
7+
# Please leave the main body empty.
8+
#
9+
# Please name the file itself for the software product: <name>.md (all lowercase)
10+
#
11+
# We've tried to require the minimum, but anything optional you choose to add will enrich your
12+
# product's entry in the catalog. To provide optional items, please uncomment the keys and complete
13+
# the value appropriately.
14+
#
15+
# Please see the accompanying README.md for more detailed information and guidance.
16+
#
17+
# BASIC PRODUCT INFORMATION (ALL REQUIRED)
18+
# name: (string) REQUIRED The name under which your product should appear in the catalog
19+
# area: (string) REQUIRED The technical area of the product. For now, we are using
20+
# the areas that were used by ECP ST, except that anything that was categorized as
21+
# NNSA Software under ECP should instead be listed under the appropriate "real" area:
22+
# Values include: "dataviz", "devtools", "mathlibs", "pmr", "sweco".
23+
# We also support the values used in e4s.yml files, though we prefer those above.
24+
# cass_member: (string) REQUIRED The name of the CASS member organization (aka software stewardship
25+
# organization) you are associated with. Values include: "FASTMath", "PEOS", "RAPIDS", "S4PST", "STEP".
26+
# (other CASS members are not stewarding software products, as far as we know: COLABS, CORSA, SWAS)
27+
# description: (string) REQUIRED A short description of your software. The `description` is always shown immediately
28+
# after the `name` and they should be considered together as, in effect constructing a sentence-length
29+
# description of the product with the form `name: desciption`. However it does not need to be a complete
30+
# sentence in the grammatical sense. Key points: The `description` should *not* repeat the `name`, it
31+
# should be in sentence case, and it should *not* end with a period.
32+
# long_description: (multiline string) REQUIRED A one-paragraph description of your software. A brief, moderately technical description
33+
# of your software's primary features and capabilities.
34+
# target_audience: (multiline string) REQUIRED A one-paragraph description of who should be interested in your software. This should be
35+
# less technical than the description -- meant to guide someone who's inexpert or just trying to
36+
# figure out who might be using the software.
37+
#
38+
# Note on multline string entries (long_description and target_audience): YAML supports a multiline string entry that allows
39+
# a value to be a paragraph (or several). A multiline string value starts with a pipe ("|") following the colon of the key, with
40+
# the text of the value starting on the following line. The entirety of the value should be indented by 2-4 spaces from the
41+
# left margin. The value ends at the next outdented text (or comment).
42+
#
43+
name: MAGMA
44+
area: mathlibs
45+
cass_member: FASTMath
46+
description: A library for BLAS and LAPACK on GPUs
47+
long_description: |
48+
MAGMA (Matrix Algebra on GPUs and Multicore Architectures) is a node-level mathematical library for dense linear algebra algorithms on GPU-accelerated HPC systems. MAGMA provides
49+
BLAS, batch BLAS, LAPACK, and batch LAPACK functionality on NVIDIA, AMD, and Intel GPUs, often complementing the industrial
50+
numerical libraries. MAGMA pioneered hybrid CPU-GPU algorithms for dense matrix factorizations, linear solvers, eigenvalue, and
51+
singular value decompositions. MAGMA has been partially adopted by NVIDIA and AMD into their numerical linear algebra libraries.
52+
It is an integral component of many DOE applications, and is part of xSDK and E4S.
53+
target_audience: |
54+
Computational scientists from various domains, numerical analysts,
55+
HPC scientists, certain AI applications, developers of other math libraries
56+
such as finite elements analysis, sparse direct solvers, computational statistics,
57+
computer vision, and others.
58+
#
59+
# PACKAGING INFORMATION
60+
# This information is used to connect your product with its E4S and Spack packages, if available.
61+
# e4s_product: (string) If your product is in E4S, list its e4S name here (may be different than `name`). If your
62+
# product is not in E4S, comment out this entry.
63+
# spack_name: (string) The name of your spack package(s), if available. If you don't have a Spack package, comment out this
64+
# entry. If your product has multiple Spack packages, list them using YAML list syntax:
65+
# spack_name:
66+
# - package1
67+
# - package2
68+
# - package3
69+
#
70+
e4s_product: MAGMA
71+
spack_name: magma
72+
#
73+
# ADDITIONAL PRODUCT INFORMATION
74+
# These are OPTIONAL lists of resource links that you can provide to make your catalog entry more useful.
75+
# The typical set includes: Website, Repository, Downloads, and Documentation, but all of these are optional, and
76+
# you can also add other labels. `additional_resource_links` is a general category; `end_user_resource_links` and
77+
# `developer_resource_links` are meant to target the named groups more specifically. Use them as you like.
78+
#
79+
# The essential inputs are structured as follows:
80+
# - label: Resource label # REQUIRED
81+
# url: https://example.com # REQUIRED
82+
# note: (additional info) # OPTIONAL
83+
# icon: fa-solid fa-font-awesome # OPTIONAL, a FontAwesome icon identifier
84+
#
85+
# Which would appear as (in pseudo-markdown):
86+
# {{ icon }} [{{ label }}]({{ url }}) {{ note }}
87+
#
88+
# For additional information, see _sw/README.md.
89+
#
90+
# additional_resource_links:
91+
# - label: Website
92+
# url:
93+
# - label: Repository
94+
# url:
95+
# - label: Downloads
96+
# url:
97+
# - label: Documentation
98+
# url:
99+
#
100+
# A set of resources specifically aimed at users of the software (OPTIONAL)
101+
#
102+
# end_user_resource_links:
103+
# - label:
104+
# url:
105+
#
106+
# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)
107+
#
108+
# developer_resource_links:
109+
# - label:
110+
# url:
111+
additional_resource_links:
112+
- label: Website
113+
url: https://icl.utk.edu/magma
114+
- label: Repository
115+
url: https://github.com/icl-utk-edu/magma
116+
- label: Documentation
117+
url: https://icl.utk.edu/projectsfiles/magma/doxygen/index.html
118+
---

_sw/mfem.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -91,31 +91,34 @@ additional_resource_links:
9191
- label: Repository
9292
url: https://github.com/mfem/mfem
9393
- label: Downloads
94-
url: https://mfem.org/downloads
94+
url: https://mfem.org/download
9595
- label: Documentation
96-
url: https://docs.mfem.org/4.7
96+
url: https://docs.mfem.org/
9797
#
9898
# A set of resources specifically aimed at users of the software (OPTIONAL)
9999
#
100100
end_user_resource_links:
101-
- label: Example Codes
102-
url: https://mfem.org/examples
103-
- label: Tutorial
104-
url: https://mfem.org/tutorial
105-
- label: Videos
106-
url: https://mfem.org/videos
107-
- label: Workshop
108-
url: https://mfem.org/workshop
109-
- label: Seminar
110-
url: https://mfem.org/seminar
101+
- label: Examples
102+
url: https://mfem.org/examples
103+
- label: Tutorials
104+
url: https://mfem.org/tutorial
105+
- label: Videos
106+
url: https://mfem.org/videos
107+
- label: Workshop
108+
url: https://mfem.org/workshop
109+
- label: Seminars
110+
url: https://mfem.org/seminar
111111
#
112112
# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)
113113
#
114-
# developer_resource_links:
115-
- label: Contribution Guidelines
116-
url: https://github.com/mfem/mfem/blob/master/CONTRIBUTING.md
117-
- label: How-to Articles
118-
url: https://mfem.org/howto/howto-index/
119-
- label: Doxygen Documentation
120-
url: https://docs.mfem.org
114+
developer_resource_links:
115+
- label: Contributor guide
116+
url: https://github.com/mfem/mfem/blob/master/CONTRIBUTING.md
117+
- label: How-to articles
118+
url: https://mfem.org/howto/howto-index/
119+
#
120+
# Duplicates a resource above
121+
# - label: Documentation
122+
# note: (Doxygen)
123+
# url: https://docs.mfem.org
121124
---

_sw/petsc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
# left margin. The value ends at the next outdented text (or comment).
4242
#
4343
name: PETSc/TAO
44-
area: Mathematical Libraries
44+
area: mathlibs
4545
cass_member: FASTMath
4646
description: The Portable, Extensible Toolkit for Scientific Computation
4747
long_description: |
@@ -98,9 +98,9 @@ additional_resource_links:
9898
# A set of resources specifically aimed at users of the software (OPTIONAL)
9999
#
100100
end_user_resource_links:
101-
- label: Discord Server
101+
- label: Discord
102102
url: https://discord.gg/Fqm8r6Gcyb
103-
- label: Mailing Lists
103+
- label: Mailing lists
104104
url: https://petsc.org/release/community/mailing/#mailing-lists
105105
#
106106
# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)

0 commit comments

Comments
 (0)