Initial submission of LibEnsemble

Author: bernhold

_sw/libEnsemble.md

@@ -0,0 +1,119 @@
+---
+# 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: libEnsemble
+area: mathlibs
+cass_member: FASTMath
+description: A Python toolkit for coordinating asynchronous and dynamic ensembles of calculations.
+long_description: |
+  Adaptive, portable, and scalable software for connecting "deciders" to experiments or simulations.
+      Dynamic ensembles: Generate parallel tasks on-the-fly based on previous computations.
+      Extreme portability and scaling: Run on or across laptops, clusters, and leadership-class machines.
+      Heterogeneous computing: Dynamically and portably assign CPUs, GPUs, or multiple nodes.
+      Application monitoring: Ensemble members can run, monitor, and cancel apps.
+      Data-flow between tasks: Running ensemble members can send and receive data.
+      Low start-up cost: No additional background services or processes required.
+  libEnsemble is effective at solving design, decision, and inference problems on parallel resources.
+target_audience: |
+    Computational Scientists and Engineers;
+    Numerical Optimization Users;
+    High-Performance Computing Practitioners;
+    Software Developers of Scientific Applications;
+    Educators and Students.
+#
+# 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: libEnsemble 
+spack_name: py-libensemble
+#
+# 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: Repository
+    url: https://github.com/Libensemble/libensemble
+  - label: Community Examples
+    url: https://github.com/Libensemble/libe-community-examples
+  - label: Documentation
+    url: https://libensemble.readthedocs.io/en/main/
+  - label: Releases
+    url: https://github.com/Libensemble/libensemble/releases
+#
+# A set of resources specifically aimed at users of the software (OPTIONAL)
+#
+end_user_resource_links:
+  - label: Slack Page
+    url: https://libensemble.slack.com/
+  - label: Mailing List
+    url: https://lists.mcs.anl.gov/mailman/listinfo/libensemble 
+#
+# A set of resources specifically aimed at developers/contributors to the software (OPTIONAL)
+#
+developer_resource_links:
+  - label: Contributing Guidelines 
+    url: https://github.com/Libensemble/libensemble/blob/main/CONTRIBUTING.rst
+  - label: Coverage
+    url: https://app.codecov.io/github/Libensemble/libensemble
+---