Add support section to docs (#128)

Author: mtfishman

Project.toml

@@ -1,7 +1,7 @@
 name = "ITensorMPS"
 uuid = "0d1a4710-d33b-49a5-8f18-73bdf49b47e2"
 authors = ["Matthew Fishman <mfishman@flatironinstitute.org>", "Miles Stoudenmire <mstoudenmire@flatironinstitute.org>"]
-version = "0.3.12"
+version = "0.3.13"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

README.md

@@ -9,6 +9,12 @@
 
 Finite MPS and MPO methods based on the Julia version of [ITensor](https://www.itensor.org) ([ITensors.jl](https://github.com/ITensor/ITensors.jl)). See the [ITensorMPS.jl documentation](https://itensor.github.io/ITensorMPS.jl) for more details.
 
+## Support
+
+<img src="docs/src/assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
+
+ITensorMPS.jl is supported by the Flatiron Institute, a division of the Simons Foundation.
+
 ## News
 
 ### ITensorMPS.jl v0.3 release notes

docs/make_index.jl

@@ -1,9 +1,20 @@
 using Literate: Literate
 using ITensorMPS: ITensorMPS
 
+function ccq_logo(content)
+  include_ccq_logo = """
+    ```@raw html
+    <img src="assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
+    ```
+    """
+  content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
+  return content
+end
+
 Literate.markdown(
   joinpath(pkgdir(ITensorMPS), "examples", "README.jl"),
   joinpath(pkgdir(ITensorMPS), "docs", "src");
   flavor=Literate.DocumenterFlavor(),
   name="index",
+  postprocess=ccq_logo,
 )

docs/make_readme.jl

@@ -1,9 +1,18 @@
 using Literate: Literate
 using ITensorMPS: ITensorMPS
 
+function ccq_logo(content)
+  include_ccq_logo = """
+    <img src="docs/src/assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo.">
+    """
+  content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
+  return content
+end
+
 Literate.markdown(
   joinpath(pkgdir(ITensorMPS), "examples", "README.jl"),
   joinpath(pkgdir(ITensorMPS));
   flavor=Literate.CommonMarkFlavor(),
   name="README",
+  preprocess=ccq_logo,
 )

examples/README.jl

@@ -8,7 +8,13 @@
 # [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 # Finite MPS and MPO methods based on the Julia version of [ITensor](https://www.itensor.org) ([ITensors.jl](https://github.com/ITensor/ITensors.jl)). See the [ITensorMPS.jl documentation](https://itensor.github.io/ITensorMPS.jl) for more details.
+
+# ## Support
+#
+# {CCQ_LOGO}
 #
+# ITensorMPS.jl is supported by the Flatiron Institute, a division of the Simons Foundation.
+
 # ## News
 #
 # ### ITensorMPS.jl v0.3 release notes