From 9e38c966f5921903978db1a69db02a22b3d64ac3 Mon Sep 17 00:00:00 2001 From: QuillPusher <130300172+QuillPusher@users.noreply.github.com> Date: Sun, 31 Mar 2024 17:31:02 -0700 Subject: [PATCH 1/3] Tweaks discussed in weekly docs meeting - added description tag to releases yml - Improved release.md layout - moved clad to top on projects page - Front Page New, etc. Widgets Made title more prominent (instead of date) - Open Projects Widget: Articles linked to relevant Anchor Headings (slugify) - added Blog Widget to Front Page (also to make Youtube widget smaller) - Moved "Execution Results" Blog up to show on Front Page --- _data/projects.yml | 33 ++++++++++--------- _data/releases.yml | 25 ++++++++++---- _includes/blog_widget.html | 16 +++++++++ _includes/news.html | 3 +- _includes/open-projects.html | 6 ++-- _includes/project-meetings.html | 4 +-- _includes/releases.html | 3 +- _layouts/homelay.html | 19 ++++++----- _pages/releases.md | 4 +-- ...tation-with-google-season-of-docs-2023.md} | 2 +- 10 files changed, 70 insertions(+), 45 deletions(-) create mode 100644 _includes/blog_widget.html rename _posts/{2023-12-31-accelerated-documentation-with-google-season-of-docs-2023.md => 2023-05-10-accelerated-documentation-with-google-season-of-docs-2023.md} (99%) diff --git a/_data/projects.yml b/_data/projects.yml index 642ec4ea..bc7f1bcf 100644 --- a/_data/projects.yml +++ b/_data/projects.yml @@ -1,3 +1,20 @@ +- name: "Clad - an Automatic Differentiation Tool" + description: | + Clad is a plugin for the Clang compiler that enables automatic differentiation + capabilities for C/C++ codebases. It is a valuable tool for developers seeking + to streamline complex mathematical computations and optimize their codebase + efficiently. + + Clad facilitates the generation of derivatives, gradients, Hessians, and + Jacobians (in forward and/or reverse mode), enhancing the efficiency and + versatility of numerical computations. + + Clad not only supports partial and higher-order derivatives but also + integrates seamlessly with frameworks like ROOT, providing a comprehensive + solution for automatic differentiation needs in C++ applications. + link: | + https://github.com/vgvassilev/clad + - name: "Xeus-CPP - a Jupyter Kernel for C++" description: | Xeus-CPP is a product of OAC-1931408 in collaboration with the QuantStack @@ -60,22 +77,6 @@ link: | https://github.com/root-project/cling -- name: "Clad - an Automatic Differentiation Tool" - description: | - Clad is a plugin for the Clang compiler that enables automatic differentiation - capabilities for C/C++ codebases. It is a valuable tool for developers seeking - to streamline complex mathematical computations and optimize their codebase - efficiently. - - Clad facilitates the generation of derivatives, gradients, Hessians, and - Jacobians (in forward and/or reverse mode), enhancing the efficiency and - versatility of numerical computations. - - Clad not only supports partial and higher-order derivatives but also - integrates seamlessly with frameworks like ROOT, providing a comprehensive - solution for automatic differentiation needs in C++ applications. - link: | - https://github.com/vgvassilev/clad diff --git a/_data/releases.yml b/_data/releases.yml index a6fe8ff2..f03403c1 100644 --- a/_data/releases.yml +++ b/_data/releases.yml @@ -1,66 +1,73 @@ - date: 2024-03-01 codebase: "CppInterOp" version: "v1.2.0" + description: "This release includes some improvements and bug fixes." link: "https://github.com/compiler-research/CppInterOp/releases/tag/v1.2.0" - date: 2024-02-29 codebase: "Clad" version: "v1.4" + description: "Forward Mode & Reverse Mode: Improve handling of char and string literals. Reverse Mode: Add support for differentiating switch statements, supportpassing pointers as call arguments, and Fix pointer arithmetic for array types." link: "https://github.com/vgvassilev/clad/releases/tag/v1.4" - date: 2024-02-11 codebase: "Clad" version: "v1.3" + description: "Forward Mode: Make forward vector mode more robust (Implement dedicated clad::matrix class, Add support for array arguments, and Add support for call expressions). Add support for the 'non_differentiable' attribute." link: "https://github.com/vgvassilev/clad/releases/tag/v1.3" - date: 2024-01-09 codebase: "Xeus-Cpp" version: "v0.3" + description: "This release includes some improvements and bug fixes." link: "https://github.com/compiler-research/xeus-cpp/releases/tag/0.3.0" - date: 2023-11-11 codebase: "CppInterOp" version: "v1.1.0" + description: "Incremental C++: Support clang plugins. Incremental CUDA: Support incremental compilation of CUDA." link: "https://github.com/compiler-research/CppInterOp/releases/tag/v1.1.0" - date: 2023-08-14 codebase: "CppInterOp" version: "v1.0" + description: "This is the first major release of CppInterOp. Incremental C++: Facilities for setting up the infrastructure such as CreateInterpreter, GetInterpreter, AddSearchPath, and AddIncludePath. Facilities for consuming incremental input such as Declare, Process and Evaluate." link: "https://github.com/compiler-research/CppInterOp/releases/tag/v1.0" - date: 2023-06-18 codebase: "Clad" version: "v1.2" + description: "Forward Mode: Add experimental support for forward vector mode and improve support of comma expressions. Reverse Mode: Add pushforwards for std::floor and std::ceil." link: "https://github.com/vgvassilev/clad/releases/tag/v1.2" - -- date: 2023-04-02 - codebase: "Initial work Xeus-Cpp in collaboration with QuantStack" - version: "v1.0" - link: "https://github.com/compiler-research/xeus-cpp" - date: 2023-01-20 codebase: "Clad" version: "v1.1" + description: "Forward Mode: Fix a bug in pow pushforward. Reverse Mode: Improve for-loop conditions." link: "https://github.com/vgvassilev/clad/releases/tag/v1.1" - date: 2022-10-07 codebase: "Clad" version: "v1.0" + description: "This is the first major release of Clad" link: "https://github.com/vgvassilev/clad/releases/tag/v1.0" - date: 2022-08-11 codebase: "Initial version of xeus-clang-repl" - version: " " - link: "https://github.com/compiler-research/xeus-clang-repl" + version: "v0.2.0" + description: "This is the initial release of xeus-clang-repl." + link: "https://github.com/compiler-research/xeus-clang-repl/releases/tag/v0.2.0" - date: 2022-03-25 codebase: "Clang-Repl released in LLVM 14" version: " " + description: "This release includes some improvements and bug fixes" link: "https://github.com/llvm/llvm-project/releases/tag/llvmorg-14.0.0" - date: 2021-10-04 codebase: "Clang-Repl released in LLVM 13" version: " " + description: "This release includes some improvements and bug fixes" link: "https://github.com/llvm/llvm-project/releases/tag/llvmorg-13.0.0" - date: 2021-08-16 @@ -71,19 +78,23 @@ - date: 2021-05-28 codebase: "Clad" version: "v0.8" + description: "This release includes some improvements and bug fixes" link: "https://github.com/vgvassilev/clad/releases/tag/v0.8" - date: 2021-05-05 codebase: "Cling" version: "v0.9" + description: "This release includes some improvements and bug fixes" link: "https://github.com/vgvassilev/cling/releases/tag/v0.9" - date: 2021-01-11 codebase: "Cling" version: "v0.8" + description: "Improve in the C++ modules support.Fix issues in the definition shadowing.Improve the integration with clad." link: "https://github.com/vgvassilev/cling/releases/tag/v0.8" - date: 2020-08-21 codebase: "Cling" version: "v0.7" + description: "This release includes some improvements and bug fixes" link: "https://github.com/vgvassilev/cling/releases/tag/v0.7" \ No newline at end of file diff --git a/_includes/blog_widget.html b/_includes/blog_widget.html new file mode 100644 index 00000000..87039500 --- /dev/null +++ b/_includes/blog_widget.html @@ -0,0 +1,16 @@ + +
+

Latest Blog

+
+ + + {% assign top_articles = site.posts | slice: 0, 1 %} + {% for article in top_articles %} +

{{article.title}}
({{ article.excerpt }})

+ {% endfor %} + + + +
+

... see more posts

+
diff --git a/_includes/news.html b/_includes/news.html index f9b3ca8b..3a936eb9 100644 --- a/_includes/news.html +++ b/_includes/news.html @@ -6,8 +6,7 @@

News

{% assign top_articles = site.data.news | slice: 0, 3 %} {% for article in top_articles %} -

- {{ article.date | date: "%Y-%m-%d" }}
{{article.headline}}

+

{{article.headline}}
({{ article.date | date: "%Y-%m-%d" }})

{% endfor %} diff --git a/_includes/open-projects.html b/_includes/open-projects.html index 1d97180a..92c19a05 100644 --- a/_includes/open-projects.html +++ b/_includes/open-projects.html @@ -1,13 +1,11 @@

Open Projects

-
+
{% assign top_articles = site.data.openprojectlist %} {% for article in top_articles limit:4 %} -

- - {{ article.name }} -

+

{{ article.name }}

{% endfor %} diff --git a/_includes/project-meetings.html b/_includes/project-meetings.html index 069d7ddf..cc3ed65c 100644 --- a/_includes/project-meetings.html +++ b/_includes/project-meetings.html @@ -4,9 +4,7 @@

Project Meetings

{% assign top_articles = site.data.meetinglist | slice: 0, 3 %} {% for article in top_articles %} -

- {{ article.date | date: "%Y-%m-%d" }}
{{ article.agenda[0].title }} -

+

{{ article.agenda[0].title }}
({{ article.date | date: "%Y-%m-%d" }})

{% endfor %}
diff --git a/_includes/releases.html b/_includes/releases.html index ee6030cb..7da7101d 100644 --- a/_includes/releases.html +++ b/_includes/releases.html @@ -6,8 +6,7 @@

Software Releases

{% assign top_articles = site.data.releases | slice: 0, 5 %} {% for article in top_articles %} -

- {{ article.date | date: "%Y-%m-%d" }}
{{article.codebase}} - {{article.version}}

+

{{article.codebase}} - {{article.version}}
({{ article.date | date: "%Y-%m-%d" }})

{% endfor %} diff --git a/_layouts/homelay.html b/_layouts/homelay.html index d8d56eeb..19709937 100644 --- a/_layouts/homelay.html +++ b/_layouts/homelay.html @@ -8,38 +8,41 @@
-
-
{% include thumbnails.html %}
-
+
{% include open-projects.html %}
-
+
{% include project-meetings.html %}
-
+
{% include releases.html %}
-
+
{% include news.html %}
-
+
{{ content }}
-
\ No newline at end of file +
+
+

+ {% include blog_widget.html %} +
+
\ No newline at end of file diff --git a/_pages/releases.md b/_pages/releases.md index 09a26b3b..0b24f7db 100644 --- a/_pages/releases.md +++ b/_pages/releases.md @@ -9,6 +9,6 @@ permalink: /releases # Releases {% for article in site.data.releases %} -

{{ article.date }}
-{{article.codebase}} - {{article.version}}

+

{{article.codebase}} - {{article.version}} ({{ article.date | date: "%-d %B %Y" }})

+

   {{article.description}} For details, please see the release notes.

{% endfor %} diff --git a/_posts/2023-12-31-accelerated-documentation-with-google-season-of-docs-2023.md b/_posts/2023-05-10-accelerated-documentation-with-google-season-of-docs-2023.md similarity index 99% rename from _posts/2023-12-31-accelerated-documentation-with-google-season-of-docs-2023.md rename to _posts/2023-05-10-accelerated-documentation-with-google-season-of-docs-2023.md index 9dc2e9df..5170eb51 100644 --- a/_posts/2023-12-31-accelerated-documentation-with-google-season-of-docs-2023.md +++ b/_posts/2023-05-10-accelerated-documentation-with-google-season-of-docs-2023.md @@ -9,7 +9,7 @@ Floating-Point Error Estimation), and Python-C++ Interoperability (Clang-Repl (LLVM), CppInterOp, cppyy, Numba, etc.)." sitemap: false permalink: blogs/gsod23_quillpusher_experience_blog/ -date: 2023-12-31 +date: 2023-05-10 --- ### How we got started From 50d524bb52d7868693c735bdacf6b8de7ca1f9e3 Mon Sep 17 00:00:00 2001 From: QuillPusher <130300172+QuillPusher@users.noreply.github.com> Date: Thu, 4 Apr 2024 09:51:13 -0700 Subject: [PATCH 2/3] Changes Requested in Weekly Meeting - Changed Description in `releases.yml` to multi-line - Added more details to Clad 1.4 Release - created a new `date.html` to uniformly include Date in the format "29 Feb 2023" everywhere - Improved `releases.md` readability by adding some padding --- _data/releases.yml | 68 +++++++++++++++++++++++++-------- _includes/date.html | 1 + _includes/news.html | 2 +- _includes/project-meetings.html | 2 +- _includes/releases.html | 2 +- _pages/releases.md | 6 ++- 6 files changed, 60 insertions(+), 21 deletions(-) create mode 100644 _includes/date.html diff --git a/_data/releases.yml b/_data/releases.yml index f03403c1..7548b509 100644 --- a/_data/releases.yml +++ b/_data/releases.yml @@ -1,100 +1,136 @@ - date: 2024-03-01 codebase: "CppInterOp" version: "v1.2.0" - description: "This release includes some improvements and bug fixes." + description: | + This release includes some improvements and bug fixes. link: "https://github.com/compiler-research/CppInterOp/releases/tag/v1.2.0" - date: 2024-02-29 codebase: "Clad" version: "v1.4" - description: "Forward Mode & Reverse Mode: Improve handling of char and string literals. Reverse Mode: Add support for differentiating switch statements, supportpassing pointers as call arguments, and Fix pointer arithmetic for array types." + description: | + **Forward Mode & Reverse Mode**: Improve handling of char and string + literals.
**Reverse Mode**: Add support for differentiating switch + statements, supportpassing pointers as call arguments, and Fix pointer + arithmetic for array types.
This release also includes **major + performance enhancements**. Add support for differentiating switch stmt in + the reverse mode AD. Make the compilation of gtest parallel. Schedule the + builds with debug clang earlier. Support BUILD_SHARED_LIBS=On flags. + Kokkos always requires rtti. link: "https://github.com/vgvassilev/clad/releases/tag/v1.4" - date: 2024-02-11 codebase: "Clad" version: "v1.3" - description: "Forward Mode: Make forward vector mode more robust (Implement dedicated clad::matrix class, Add support for array arguments, and Add support for call expressions). Add support for the 'non_differentiable' attribute." + description: | + **Forward Mode**: Make forward vector mode more robust (Implement + dedicated clad::matrix class, Add support for array arguments, and Add + support for call expressions). Add support for the 'non_differentiable' + attribute. link: "https://github.com/vgvassilev/clad/releases/tag/v1.3" - date: 2024-01-09 codebase: "Xeus-Cpp" version: "v0.3" - description: "This release includes some improvements and bug fixes." + description: | + This release includes some improvements and bug fixes. link: "https://github.com/compiler-research/xeus-cpp/releases/tag/0.3.0" - date: 2023-11-11 codebase: "CppInterOp" version: "v1.1.0" - description: "Incremental C++: Support clang plugins. Incremental CUDA: Support incremental compilation of CUDA." + description: | + Incremental C++: Support clang plugins. Incremental CUDA: Support + incremental compilation of CUDA. link: "https://github.com/compiler-research/CppInterOp/releases/tag/v1.1.0" - date: 2023-08-14 codebase: "CppInterOp" version: "v1.0" - description: "This is the first major release of CppInterOp. Incremental C++: Facilities for setting up the infrastructure such as CreateInterpreter, GetInterpreter, AddSearchPath, and AddIncludePath. Facilities for consuming incremental input such as Declare, Process and Evaluate." + description: | + This is the first major release of CppInterOp. Incremental C++: Facilities + for setting up the infrastructure such as CreateInterpreter, + GetInterpreter, AddSearchPath, and AddIncludePath. Facilities for + consuming incremental input such as Declare, Process and Evaluate. link: "https://github.com/compiler-research/CppInterOp/releases/tag/v1.0" - date: 2023-06-18 codebase: "Clad" version: "v1.2" - description: "Forward Mode: Add experimental support for forward vector mode and improve support of comma expressions. Reverse Mode: Add pushforwards for std::floor and std::ceil." + description: | + **Forward Mode**: Add experimental support for forward vector mode and + improve support of comma expressions.
**Reverse Mode**: Add + pushforwards for std::floor and std::ceil. link: "https://github.com/vgvassilev/clad/releases/tag/v1.2" - date: 2023-01-20 codebase: "Clad" version: "v1.1" - description: "Forward Mode: Fix a bug in pow pushforward. Reverse Mode: Improve for-loop conditions." + description: | + **Forward Mode**: Fix a bug in pow pushforward.
**Reverse Mode**: + Improve for-loop conditions. link: "https://github.com/vgvassilev/clad/releases/tag/v1.1" - date: 2022-10-07 codebase: "Clad" version: "v1.0" - description: "This is the first major release of Clad" + description: | + This is the first major release of Clad link: "https://github.com/vgvassilev/clad/releases/tag/v1.0" - date: 2022-08-11 codebase: "Initial version of xeus-clang-repl" version: "v0.2.0" - description: "This is the initial release of xeus-clang-repl." + description: | + This is the initial release of xeus-clang-repl. link: "https://github.com/compiler-research/xeus-clang-repl/releases/tag/v0.2.0" - date: 2022-03-25 codebase: "Clang-Repl released in LLVM 14" version: " " - description: "This release includes some improvements and bug fixes" + description: | + This release includes some improvements and bug fixes. link: "https://github.com/llvm/llvm-project/releases/tag/llvmorg-14.0.0" - date: 2021-10-04 codebase: "Clang-Repl released in LLVM 13" version: " " - description: "This release includes some improvements and bug fixes" + description: | + This release includes some improvements and bug fixes. link: "https://github.com/llvm/llvm-project/releases/tag/llvmorg-13.0.0" - date: 2021-08-16 codebase: "Clad" version: "v0.9" + description: | + This release includes some improvements and bug fixes. link: "https://github.com/vgvassilev/clad/releases/tag/v0.9" - date: 2021-05-28 codebase: "Clad" version: "v0.8" - description: "This release includes some improvements and bug fixes" + description: | + This release includes some improvements and bug fixes. link: "https://github.com/vgvassilev/clad/releases/tag/v0.8" - date: 2021-05-05 codebase: "Cling" version: "v0.9" - description: "This release includes some improvements and bug fixes" + description: | + This release includes some improvements and bug fixes. link: "https://github.com/vgvassilev/cling/releases/tag/v0.9" - date: 2021-01-11 codebase: "Cling" version: "v0.8" - description: "Improve in the C++ modules support.Fix issues in the definition shadowing.Improve the integration with clad." + description: | + Improve in the C++ modules support. Fix issues in the definition + shadowing.Improve the integration with clad. link: "https://github.com/vgvassilev/cling/releases/tag/v0.8" - date: 2020-08-21 codebase: "Cling" version: "v0.7" - description: "This release includes some improvements and bug fixes" + description: | + This release includes some improvements and bug fixes. link: "https://github.com/vgvassilev/cling/releases/tag/v0.7" \ No newline at end of file diff --git a/_includes/date.html b/_includes/date.html new file mode 100644 index 00000000..d1e07491 --- /dev/null +++ b/_includes/date.html @@ -0,0 +1 @@ +{{ article.date | date: "%-d %b %Y" }} \ No newline at end of file diff --git a/_includes/news.html b/_includes/news.html index 3a936eb9..51d4c584 100644 --- a/_includes/news.html +++ b/_includes/news.html @@ -6,7 +6,7 @@

News

{% assign top_articles = site.data.news | slice: 0, 3 %} {% for article in top_articles %} -

{{article.headline}}
({{ article.date | date: "%Y-%m-%d" }})

+

{{article.headline}}
{% include date.html %}

{% endfor %} diff --git a/_includes/project-meetings.html b/_includes/project-meetings.html index cc3ed65c..308aed8f 100644 --- a/_includes/project-meetings.html +++ b/_includes/project-meetings.html @@ -4,7 +4,7 @@

Project Meetings

{% assign top_articles = site.data.meetinglist | slice: 0, 3 %} {% for article in top_articles %} -

{{ article.agenda[0].title }}
({{ article.date | date: "%Y-%m-%d" }})

+

{{ article.agenda[0].title }}
{% include date.html %}

{% endfor %}
diff --git a/_includes/releases.html b/_includes/releases.html index 7da7101d..6c87d833 100644 --- a/_includes/releases.html +++ b/_includes/releases.html @@ -6,7 +6,7 @@

Software Releases

{% assign top_articles = site.data.releases | slice: 0, 5 %} {% for article in top_articles %} -

{{article.codebase}} - {{article.version}}
({{ article.date | date: "%Y-%m-%d" }})

+

{{article.codebase}} - {{article.version}}
{% include date.html %}

{% endfor %} diff --git a/_pages/releases.md b/_pages/releases.md index 0b24f7db..efa1251b 100644 --- a/_pages/releases.md +++ b/_pages/releases.md @@ -9,6 +9,8 @@ permalink: /releases # Releases {% for article in site.data.releases %} -

{{article.codebase}} - {{article.version}} ({{ article.date | date: "%-d %B %Y" }})

-

   {{article.description}} For details, please see the release notes.

+

{{article.codebase}} - {{article.version}} ({% include date.html %})

+
+

{{article.description}} For details, please see the release notes.

+
{% endfor %} From d690a95476fe93248f8d5bc97b11fd45dbca5d65 Mon Sep 17 00:00:00 2001 From: QuillPusher <130300172+QuillPusher@users.noreply.github.com> Date: Sun, 7 Apr 2024 17:38:10 -0700 Subject: [PATCH 3/3] Improved Date inclusion --- _includes/date.html | 3 ++- _includes/news.html | 4 ++-- _includes/project-meetings.html | 2 +- _includes/releases.html | 2 +- _pages/releases.md | 5 ++++- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/_includes/date.html b/_includes/date.html index d1e07491..33250209 100644 --- a/_includes/date.html +++ b/_includes/date.html @@ -1 +1,2 @@ -{{ article.date | date: "%-d %b %Y" }} \ No newline at end of file +{% assign my_date = include.date %} +{{ my_date | date: "%-d %b %Y" }} \ No newline at end of file diff --git a/_includes/news.html b/_includes/news.html index 51d4c584..e434e60d 100644 --- a/_includes/news.html +++ b/_includes/news.html @@ -6,10 +6,10 @@

News

{% assign top_articles = site.data.news | slice: 0, 3 %} {% for article in top_articles %} -

{{article.headline}}
{% include date.html %}

+

{{article.headline}}
{% include date.html date=article.date %}

{% endfor %} - +

... see details

diff --git a/_includes/project-meetings.html b/_includes/project-meetings.html index 308aed8f..5bb8c822 100644 --- a/_includes/project-meetings.html +++ b/_includes/project-meetings.html @@ -4,7 +4,7 @@

Project Meetings

{% assign top_articles = site.data.meetinglist | slice: 0, 3 %} {% for article in top_articles %} -

{{ article.agenda[0].title }}
{% include date.html %}

+

{{ article.agenda[0].title }}
{% include date.html date=article.date %}

{% endfor %}
diff --git a/_includes/releases.html b/_includes/releases.html index 6c87d833..9b7e6a6f 100644 --- a/_includes/releases.html +++ b/_includes/releases.html @@ -6,7 +6,7 @@

Software Releases

{% assign top_articles = site.data.releases | slice: 0, 5 %} {% for article in top_articles %} -

{{article.codebase}} - {{article.version}}
{% include date.html %}

+

{{article.codebase}} - {{article.version}}
{% include date.html date=article.date %}

{% endfor %} diff --git a/_pages/releases.md b/_pages/releases.md index efa1251b..98ff2720 100644 --- a/_pages/releases.md +++ b/_pages/releases.md @@ -8,9 +8,12 @@ permalink: /releases # Releases + {% for article in site.data.releases %} -

{{article.codebase}} - {{article.version}} ({% include date.html %})

+
+

{{article.codebase}} - {{article.version}}
{% include date.html date=article.date %}

{{article.description}} For details, please see the release notes.

+
{% endfor %}