Merge pull request #229 from sandialabs/pages

pages
sandialabs · May 18, 2024 · 1f43a2b · 1f43a2b
2 parents 623842f + e486263
commit 1f43a2b
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 9 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -42,9 +42,9 @@ jobs:
           julia --color=yes -e 'using Pkg; Pkg.add(url="https://github.com/sandialabs/Polymers", rev="'${{ steps.last_release.outputs.tag_name }}'")'
           mkdir -p _site/julia/docs/stable/
           julia --color=yes -e 'using Pkg; Pkg.add(["DocStringExtensions", "Documenter"])'
-          julia --color=yes docs/make.jl
-          grep -rl "footer-message" docs/build/ | xargs sed -i 's@<p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p>@<footer><a href="http://sandia.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="Sandia National Laboratories" longdesc="http://sandia.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/SNL_Horizontal_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://energy.gov" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="U.S. Department of Energy" longdesc="http://energy.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/New_DOE_Logo_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://nnsa.energy.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="National Nuclear Security Administration" longdesc="http://nnsa.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/NNSA Logo_White.png" style="height:37px"></a><br><br><div style="font-size: 0.8em">Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy\x27s National Nuclear Security Administration under contract DE-NA-0003525.</div></footer>@'
-          cp -r docs/build/* _site/julia/docs/stable/
+          # julia --color=yes docs/make.jl
+          # grep -rl "footer-message" docs/build/ | xargs sed -i 's@<p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p>@<footer><a href="http://sandia.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="Sandia National Laboratories" longdesc="http://sandia.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/SNL_Horizontal_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://energy.gov" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="U.S. Department of Energy" longdesc="http://energy.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/New_DOE_Logo_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://nnsa.energy.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="National Nuclear Security Administration" longdesc="http://nnsa.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/NNSA Logo_White.png" style="height:37px"></a><br><br><div style="font-size: 0.8em">Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy\x27s National Nuclear Security Administration under contract DE-NA-0003525.</div></footer>@'
+          # cp -r docs/build/* _site/julia/docs/stable/
       - name: add latest julia
         if: github.event_name != 'pull_request'
         run: julia --color=yes -e 'using Pkg; Pkg.add(url="https://github.com/sandialabs/Polymers", rev="'${GITHUB_REF##*/}'")'
@@ -55,9 +55,9 @@ jobs:
         run: |
           mkdir -p _site/julia/docs/latest/
           julia --color=yes -e 'using Pkg; Pkg.add(["DocStringExtensions", "Documenter"])'
-          julia --color=yes docs/make.jl
-          grep -rl "footer-message" docs/build/ | xargs sed -i 's@<p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p>@<footer><a href="http://sandia.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="Sandia National Laboratories" longdesc="http://sandia.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/SNL_Horizontal_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://energy.gov" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="U.S. Department of Energy" longdesc="http://energy.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/New_DOE_Logo_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://nnsa.energy.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="National Nuclear Security Administration" longdesc="http://nnsa.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/NNSA Logo_White.png" style="height:37px"></a><br><br><div style="font-size: 0.8em">Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy\x27s National Nuclear Security Administration under contract DE-NA-0003525.</div></footer>@'
-          cp -r docs/build/* _site/julia/docs/latest/
+          # julia --color=yes docs/make.jl
+          # grep -rl "footer-message" docs/build/ | xargs sed -i 's@<p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p>@<footer><a href="http://sandia.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="Sandia National Laboratories" longdesc="http://sandia.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/SNL_Horizontal_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://energy.gov" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="U.S. Department of Energy" longdesc="http://energy.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/New_DOE_Logo_White.png" style="height:37px"></a>\&nbsp;\&nbsp;\&nbsp;<a href="http://nnsa.energy.gov/" rel="noopener noreferrer" target="_blank" style="text-decoration: none"><img alt="National Nuclear Security Administration" longdesc="http://nnsa.gov" src="https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/NNSA Logo_White.png" style="height:37px"></a><br><br><div style="font-size: 0.8em">Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy\x27s National Nuclear Security Administration under contract DE-NA-0003525.</div></footer>@'
+          # cp -r docs/build/* _site/julia/docs/latest/
       - uses: actions/upload-pages-artifact@v3
   deploy:
     if: github.event_name != 'pull_request'

diff --git a/pages/_config.yml b/pages/_config.yml
@@ -1,8 +1,7 @@
 title: Polymers
 tagline: Polymers Modeling Library
 description: >-
-  Hello world!
-  Description goes here!
+  Polymers Modeling Library
 url: "https://sandialabs.github.io"
 baseurl: "/Polymers"
 

diff --git a/pages/index.md b/pages/index.md
@@ -8,4 +8,55 @@ permalink: /
 
 # Polymers Modeling Library
 
-Hello world!
+[![website](https://img.shields.io/badge/GitHub-website-6e5494?logo=github)](https://sandialabs.github.io/Polymers)
+[![examples](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/binder.svg)](https://mybinder.org/v2/gh/sandialabs/Polymers/main)
+
+The library is implemented entirely in Rust, including the Python API. The Julia API calls the Rust library.
+
+## Python
+
+[![docs (stable)](https://img.shields.io/badge/Docs-stable-8CA1AF?logo=readthedocs)](https://polymers.readthedocs.io/en/stable)
+[![docs (latest)](https://img.shields.io/badge/Docs-latest-8CA1AF?logo=readthedocs)](https://polymers.readthedocs.io/en/latest)
+[![pypi](https://img.shields.io/pypi/v/polymers?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE)](https://pypi.org/project/polymers)
+
+The library can be installed as a Python package:
+
+```shell
+pip install polymers
+```
+
+## Julia
+
+[![docs (stable)](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/julia-docs-stable.svg)](https://sandialabs.github.io/Polymers/julia/docs/stable)
+[![docs (latest)](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/julia-docs-latest.svg)](https://sandialabs.github.io/Polymers/julia/docs/latest)
+[![Pkg](https://img.shields.io/github/v/release/sandialabs/Polymers?color=cb3c33&label=Pkg&logo=Julia&logoColor=cb3c33)](#)
+
+The library can be installed as a Julia package:
+
+```julia
+pkg> add Polymers
+```
+
+## Rust
+
+[![docs (stable)](https://img.shields.io/badge/Docs-stable-e57300?logo=rust&logoColor=000000)](https://docs.rs/crate/polymers)
+[![docs (latest)](https://img.shields.io/badge/Docs-latest-e57300?logo=rust&logoColor=000000)](https://sandialabs.github.io/Polymers/rust/docs/latest)
+[![crates](https://img.shields.io/crates/v/polymers?logo=rust&logoColor=000000&label=Crates&color=32592f)](https://crates.io/crates/polymers)
+
+The library can be added to an existing Rust project:
+
+```shell
+cargo add polymers
+```
+
+## Citation
+
+[![doi](https://img.shields.io/badge/Zenodo-10.5281%2Fzenodo.7041983-blue)](https://doi.org/10.5281/zenodo.7041983)
+
+Michael R. Buche. Polymers Modeling Library. [Zenodo (2023)](https://doi.org/10.5281/zenodo.7041983).
+
+## Copyright
+
+[![license](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/bsd3c.svg)](https://github.com/sandialabs/polymers/blob/main/LICENSE)
+
+Copyright 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.