Add basic Jekyll site

BlackHolePerturbationToolkit · Dec 17, 2024 · a89f2b4 · a89f2b4
1 parent 214d976
commit a89f2b4
Show file tree

Hide file tree

Showing 6 changed files with 133 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,4 @@
+theme: jekyll-theme-cayman
+title: Black Hole Perturbation Toolkit
+description: Open tools for black hole perturbation theory
+google_analytics: UA-136279496-1
diff --git a/_includes/head.html b/_includes/head.html
@@ -0,0 +1,13 @@
+<head>
+       <script type="text/x-mathjax-config"> MathJax.Hub.Config({ TeX: { equationNumbers: { autoNumber: "all" } } }); </script>
+       <script type="text/x-mathjax-config">
+         MathJax.Hub.Config({
+           tex2jax: {
+             inlineMath: [ ['$','$'], ["\\(","\\)"] ],
+             processEscapes: true
+           }
+         });
+       </script>
+       <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+
+</head>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+
+{% seo %}
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="theme-color" content="#157878">
+    <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+  </head>
+  <body>
+    <section class="page-header">
+      <h1 class="project-name">Black Hole Perturbation Toolkit</h1>
+      <h2 class="project-tagline">Open tools for black hole perturbation theory</h2>
+	    <a href="https://bhptoolkit.org/index.html" class = "btn">Introduction</a>
+        <a href="https://bhptoolkit.org/toolkit.html" class="btn">Toolkit and Data Repository</a>
+        <a href="https://bhptoolkit.org/documentation.html" class="btn">Status and Documentation</a>
+        <a href="https://bhptoolkit.org/users.html" class="btn">Contributors and Users</a>
+    </section>
+
+    <section class="main-content">
+      {{ content }}
+
+      <footer class="site-footer">
+        {% if site.github.is_project_page %}
+          <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+        {% endif %}
+        <span class="site-footer-credits">See behind the scenes: <a href="https://github.com/BlackHolePerturbationToolkit">View the Toolkit on GitHub</a></span>
+      </footer>
+    </section>
+
+    {% if site.google_analytics %}
+      <script type="text/javascript">
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+        ga('create', '{{ site.google_analytics }}', 'auto');
+        ga('send', 'pageview');
+      </script>
+    {% endif %}
+  </body>
+</html>
diff --git a/assets/css/style.scss b/assets/css/style.scss
@@ -0,0 +1,38 @@
+---
+---
+
+@import "{{ site.theme }}";
+
+.page-header {
+  color: $header-heading-color;
+  text-align: center;
+  background-color: $header-bg-color;
+  background-image: linear-gradient(120deg, $header-bg-color-secondary, $header-bg-color);
+
+  @include large {
+    padding: 1rem 2rem;
+  }
+
+  @include medium {
+    padding: 1rem 2rem;
+  }
+
+  @include small {
+    padding: 1rem 1rem;
+  }
+}
+
+
+.code_btn{
+	color: rgba(255,255,255,1);
+	background-color: rgba(255, 0, 0, 0.6);
+	padding: 10px;
+	border-style: solid;
+	border-color:red;
+	border-width:1px;
+	border-radius: 0.4rem;	
+
+	text-decoration: none;
+
+	transition: color 0.2s, background-color 0.2s, border-color 0.2s;
+}
diff --git a/index.md b/index.md
@@ -0,0 +1,34 @@
+{% include head.html %}
+
+# TInvar
+
+The TInvar package provides a set of functions for canonicalization of expressions involving the Riemann tensor.
+```Mathematica
+<< xAct`TInvar`
+DefManifold[M, 4, IndexRange[a, f]];
+DefMetric[-1, g[-a, -b], CD];
+RiemannSimplify[RiemannCD[a, b, c, d] + RiemannCD[a, c, d, b] + RiemannCD[a, d, b, c]]
+```
+
+## Installation
+
+1. To run this package you need to have [xAct](http://www.xact.es/) installed.
+2. TInvar is distributed as a Paclet that can be installed using [PacletInstall](https://reference.wolfram.com/language/ref/PacletInstall.html.en). For example, to install the latest version from the Black Hole Perturbation Toolkit Paclet Server:
+```Mathematica
+PacletSiteRegister["https://pacletserver.bhptoolkit.org", "Black Hole Perturbation Toolkit Paclet Server"]
+PacletInstall["TInvar"]
+```
+
+## Documentation
+
+Usage examples can be found in the documentation. This is available [online](https://bhptoolkit.org/TInvar/doc/html/guide/TInvar.html) and within the Wolfram Documentation Center by selecting Help &#8594; Wolfram Documentation from then menu and searching for `TInvar`.
+
+## Authors
+
+TInvar was created by:
+
+Kevin Kiely, Barry Wardell, Adrian Ottewill and José M. Martín-García.
+
+It is based on Invar and Invar2, which were created by:
+
+José M. Martín-García, David Yllanes, Renato Portugal and Leon Manssur.