|
| 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 | +# cass_member: (list) REQUIRED The name(s) of the CASS member organization(s) (aka software stewardship |
| 24 | +# organization(s)) you are associated with. Values include: "FASTMath", "PEOS", "RAPIDS", "S4PST", "STEP". |
| 25 | +# (other CASS members are not stewarding software products, as far as we know: COLABS, CORSA, SWAS) |
| 26 | +# description: (string) REQUIRED A short description of your software. The `description` is always shown immediately |
| 27 | +# after the `name` and they should be considered together as, in effect constructing a sentence-length |
| 28 | +# description of the product with the form `name: desciption`. However it does not need to be a complete |
| 29 | +# sentence in the grammatical sense. Key points: The `description` should *not* repeat the `name`, it |
| 30 | +# should be in sentence case, and it should *not* end with a period. |
| 31 | +# long_description: (multiline string) REQUIRED A one-paragraph description of your software. A brief, moderately technical description |
| 32 | +# of your software's primary features and capabilities. |
| 33 | +# target_audience: (multiline string) REQUIRED A one-paragraph description of who should be interested in your software. This should be |
| 34 | +# less technical than the description -- meant to guide someone who's inexpert or just trying to |
| 35 | +# figure out who might be using the software. |
| 36 | +# |
| 37 | +# Note on multline string entries (long_description and target_audience): YAML supports a multiline string entry that allows |
| 38 | +# a value to be a paragraph (or several). A multiline string value starts with a pipe ("|") following the colon of the key, with |
| 39 | +# the text of the value starting on the following line. The entirety of the value should be indented by 2-4 spaces from the |
| 40 | +# left margin. The value ends at the next outdented text (or comment). |
| 41 | +# |
| 42 | +name: PUMI Components |
| 43 | +area: mathlibs |
| 44 | +cass_members: |
| 45 | + - FASTMath |
| 46 | +description: Provides support for unstructured mesh workflows including mesh adaption, hybrid particle-mesh calculations, and solution transfer |
| 47 | +long_description: | |
| 48 | + The PUMI Components provide support for a range of unstructured mesh workflows, such as mesh adaption, particle-in-cell calculations, and developing support for field-transfer and parallel control of coupled applications. The PUMI components are an integrated set of codes that make up each of these pieces as follows: [PUMI](https://github.com/SCOREC/core) provides unstructured mesh adaptation on CPUs, while [Omega_h](https://github.com/SCOREC/omega_h) supports similar functionality on GPUs. [PUMIPic](https://github.com/SCOREC/pumi-pic), provides parallel infrastructure for particle-in-cell calculations. And, [PCMS](https://github.com/SCOREC/pcms) provides parallel control and field transfer to support coupling independent applications. |
| 49 | +target_audience: | |
| 50 | + Science and engineering application developers who need performant infrastructure for unstructured mesh workflows. The PUMI components are widely across a wide range of application domains including fusion/plasma models, land and sea ice, FEM-based solid and fluid simulations, etc. |
| 51 | +# |
| 52 | +# License information, following https://spdx.org/licenses/ |
| 53 | +# |
| 54 | +license_spdx: BSD-3-Clause |
| 55 | +# |
| 56 | +# OpenSSF Best Practices project ID (as found on https://www.bestpractices.dev/en/projects) |
| 57 | +# |
| 58 | +openssf_bestpractices_id: |
| 59 | +# |
| 60 | +foundation_membership: |
| 61 | +# |
| 62 | +# PACKAGING INFORMATION |
| 63 | +# This information is used to connect your product with its E4S and Spack packages, if available. |
| 64 | +# e4s_product: (string) If your product is in E4S, list its e4S name here (may be different than `name`). If your |
| 65 | +# product is not in E4S, comment out this entry. |
| 66 | +# spack_name: (string) The name of your spack package(s), if available. If you don't have a Spack package, comment out this |
| 67 | +# entry. If your product has multiple Spack packages, list them using YAML list syntax: |
| 68 | +# spack_name: |
| 69 | +# - package1 |
| 70 | +# - package2 |
| 71 | +# - package3 |
| 72 | +# |
| 73 | +# Commenting these out until the E4S packages get updated |
| 74 | +# e4s_product: |
| 75 | +# - core |
| 76 | +# - omega_h |
| 77 | +spack_name: |
| 78 | + - pumi |
| 79 | + - omega-h |
| 80 | + |
| 81 | +# |
| 82 | +# ADDITIONAL PRODUCT INFORMATION |
| 83 | +# These are OPTIONAL lists of resource links that you can provide to make your catalog entry more useful. |
| 84 | +# The typical set includes: Website, Repository, Downloads, and Documentation, but all of these are optional, and |
| 85 | +# you can also add other labels. `additional_resource_links` is a general category; `end_user_resource_links` and |
| 86 | +# `developer_resource_links` are meant to target the named groups more specifically. Use them as you like. |
| 87 | +# |
| 88 | +# The essential inputs are structured as follows: |
| 89 | +# - label: Resource label # REQUIRED |
| 90 | +# url: https://example.com # REQUIRED |
| 91 | +# note: (additional info) # OPTIONAL |
| 92 | +# icon: fa-solid fa-font-awesome # OPTIONAL, a FontAwesome icon identifier |
| 93 | +# |
| 94 | +# Which would appear as (in pseudo-markdown): |
| 95 | +# {{ icon }} [{{ label }}]({{ url }}) {{ note }} |
| 96 | +# |
| 97 | +# For additional information, see _software/README.md. |
| 98 | +# |
| 99 | +additional_resource_links: |
| 100 | + - label: Website |
| 101 | + url: https://scorec.rpi.edu/software |
| 102 | + - label: Repository |
| 103 | + url: https://github.com/SCOREC/core |
| 104 | + note: (PUMI core) |
| 105 | + - label: Repository |
| 106 | + url: https://github.com/SCOREC/omega_h |
| 107 | + note: (Omega_h) |
| 108 | + - label: Repository |
| 109 | + url: https://github.com/SCOREC/pumi-pic |
| 110 | + note: (PUMIPic) |
| 111 | + - label: Repository |
| 112 | + url: https://github.com/SCOREC/pcms |
| 113 | + note: (PCMS) |
| 114 | +# |
| 115 | +# A set of resources specifically aimed at users of the software (OPTIONAL) |
| 116 | +# |
| 117 | +# end_user_resource_links: |
| 118 | +# - label: |
| 119 | +# url: |
| 120 | +# |
| 121 | +# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL) |
| 122 | +# |
| 123 | +# developer_resource_links: |
| 124 | +# - label: |
| 125 | +# url: |
| 126 | +--- |
0 commit comments