diff --git a/README.md b/README.md index 0794f9a..46f2982 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Software Modernization Team: The Code Nebulae This is the team sandbox repository, storing early PoC, relevant benchmark data, staging `ci` workflows, etc. -Shortname for the packge is `tcn`. +Shortname for the package is `tcn`. 🚧 This is a staging/PoC area for code, inherently every code here is unstable. 🚧 @@ -10,10 +10,10 @@ Below is a quick summary of the tools/packages present in code. More information ## `ci` -On-premise CI for the GPU ports of GEOS. Includes validation & benchmark worfklows. +On-premise CI for the GPU ports of GEOS. Includes validation & benchmark workflows. Heartbeat insure the workflow to reach Discover is working. -Validation capacities in the case of GEOS is stricly building & running the GPU-enabled version. +Validation capacities in the case of GEOS is strictly building & running the GPU-enabled version. Validation capacities for physics compares OACC and original Fortran on. | Validation | Status | @@ -33,11 +33,11 @@ Collection of scripts to mine GEOS log for relevant timing informations for DSL ## `py_ftn_interface` -Generator of Python <> Interface based on CFFI as used in GEOS integration of the DSL. To be used as a strating point. +Generator of Python <> Interface based on CFFI as used in GEOS integration of the DSL. To be used as a starting point. ## `plots` -Collection of scriupts to plot various outputs of GEOS and DSL. +Collection of scripts to plot various outputs of GEOS and DSL. ## Software stack builder (`sw_stack`) @@ -53,4 +53,4 @@ Build with pdoc with: pdoc -o ./docs smtn ``` -Documentation is available on [Github Pages](https://geos-esm.github.io/SMT-Nebulae/SMT-Nebulae.html) and will be build automatically at every `main` commit +Documentation is available on [Github Pages](https://geos-esm.github.io/SMT-Nebulae) and will be build automatically at every `main` commit diff --git a/ndsl_documentation/README.md b/ndsl_documentation/README.md new file mode 100644 index 0000000..a9d197a --- /dev/null +++ b/ndsl_documentation/README.md @@ -0,0 +1,3 @@ +# NDSL documentation + +A space to keep early prototype technical documentation for the [NASA/NOAA DSL middleware](https://github.com/NOAA-GFDL/NDSL). This will mostly contain early drafts, prototypes, whitepapers, ... since design decisions should be documented (with the code) in the respective repository (e.g. [NDSL](https://github.com/NOAA-GFDL/NDSL) / [DaCe](https://github.com/spcl/dace) / [GT4Py](https://github.com/GridTools/gt4py/)). diff --git a/ndsl_documentation/gt4py-dace-bridge/README.md b/ndsl_documentation/gt4py-dace-bridge/README.md new file mode 100644 index 0000000..cfb025f --- /dev/null +++ b/ndsl_documentation/gt4py-dace-bridge/README.md @@ -0,0 +1,3 @@ +# Improved GT4Py-DaCe bridge + +Issue: diff --git a/ndsl_documentation/gt4py-dace-bridge/code-blocks.drawio b/ndsl_documentation/gt4py-dace-bridge/code-blocks.drawio new file mode 100644 index 0000000..144df07 --- /dev/null +++ b/ndsl_documentation/gt4py-dace-bridge/code-blocks.drawio @@ -0,0 +1,81 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +