From 9561a11e03ac26c8cc756d9aba095a8223beb6e3 Mon Sep 17 00:00:00 2001 From: Shin-Rong Tsai Date: Wed, 15 Nov 2023 20:31:11 -0600 Subject: [PATCH 1/2] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da317338..67f3e00a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # libyt -[![build-test](https://github.com/cindytsai/libyt/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/cindytsai/libyt/actions/workflows/build-test.yml) +[![CMake Build Test](https://github.com/cindytsai/libyt/actions/workflows/cmake-build-test.yml/badge.svg)](https://github.com/cindytsai/libyt/actions/workflows/cmake-build-test.yml) +[![GNU Make Build Test](https://github.com/cindytsai/libyt/actions/workflows/make-build-test.yml/badge.svg)](https://github.com/cindytsai/libyt/actions/workflows/make-build-test.yml) `libyt` is an open source C library for simulation, that allows researchers to analyze and visualize data using [`yt`](https://yt-project.org/) or other Python packages in parallel during simulation runtime. In this way, we can skip the step of writing data to local disk before doing analysis using Python. This greatly reduce the disk usage, and increase the temporal resolution. From 11e6d08f39af4b2118a9ce8413bc688322219e1c Mon Sep 17 00:00:00 2001 From: cindytsai Date: Wed, 15 Nov 2023 21:02:41 -0600 Subject: [PATCH 2/2] Prepare to pr, and make github action install yt-libyt from PyPI. --- .github/workflows/cmake-build-test.yml | 6 +----- .github/workflows/make-build-test.yml | 6 +----- .github/workflows/pages.yml | 1 - .pre-commit-config.yaml | 2 +- README.md | 12 ++++-------- doc/_config.yml | 8 ++++---- doc/index.md | 2 +- 7 files changed, 12 insertions(+), 25 deletions(-) diff --git a/.github/workflows/cmake-build-test.yml b/.github/workflows/cmake-build-test.yml index 22ea22ed..fa3e5a58 100644 --- a/.github/workflows/cmake-build-test.yml +++ b/.github/workflows/cmake-build-test.yml @@ -53,11 +53,7 @@ jobs: - name: Install yt, mpi4py, and yt_libyt run: | pip install mpi4py yt - cd ${{ github.workspace }} - cd .. - git clone --depth 1 -b libyt-dev --single-branch "https://github.com/cindytsai/yt_libyt.git" yt_libyt - cd yt_libyt - pip install . + pip install yt-libyt - name: Update GitHub Environment Variables run: | diff --git a/.github/workflows/make-build-test.yml b/.github/workflows/make-build-test.yml index c9fafac9..ffa66c06 100644 --- a/.github/workflows/make-build-test.yml +++ b/.github/workflows/make-build-test.yml @@ -50,11 +50,7 @@ jobs: - name: Install yt, mpi4py, and yt_libyt run: | pip install mpi4py yt - cd ${{ github.workspace}} - cd .. - git clone --depth 1 -b libyt-dev --single-branch "https://github.com/cindytsai/yt_libyt.git" yt_libyt - cd yt_libyt - pip install . + pip install yt-libyt - name: Update GitHub Environment Variables run: | diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index d5685a40..5c37c89e 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -10,7 +10,6 @@ on: push: branches: - "main" - - "doc" paths: - "doc/**" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4529c74e..455a54c0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,7 +12,7 @@ ci: repos: - repo: https://github.com/pre-commit/mirrors-clang-format - rev: v14.0.6 + rev: v17.0.4 hooks: - id: clang-format types_or: ['c++', 'c'] diff --git a/README.md b/README.md index 67f3e00a..e273ee93 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@ # libyt -[![CMake Build Test](https://github.com/cindytsai/libyt/actions/workflows/cmake-build-test.yml/badge.svg)](https://github.com/cindytsai/libyt/actions/workflows/cmake-build-test.yml) -[![GNU Make Build Test](https://github.com/cindytsai/libyt/actions/workflows/make-build-test.yml/badge.svg)](https://github.com/cindytsai/libyt/actions/workflows/make-build-test.yml) +[![CMake Build Test](https://github.com/yt-project/libyt/actions/workflows/cmake-build-test.yml/badge.svg)](https://github.com/yt-project/libyt/actions/workflows/cmake-build-test.yml) +[![GNU Make Build Test](https://github.com/yt-project/libyt/actions/workflows/make-build-test.yml/badge.svg)](https://github.com/yt-project/libyt/actions/workflows/make-build-test.yml) `libyt` is an open source C library for simulation, that allows researchers to analyze and visualize data using [`yt`](https://yt-project.org/) or other Python packages in parallel during simulation runtime. In this way, we can skip the step of writing data to local disk before doing analysis using Python. This greatly reduce the disk usage, and increase the temporal resolution. -This is my personal repo. It is only for developing purpose. - -- **Official Repo**: https://github.com/yt-project/libyt -- **Official Doc**: https://yt-project.github.io/libyt/ -- **See `libyt` working progress**: [Project Board](https://github.com/calab-ntu/libyt/projects/1) -- **Documents (my version)**: https://cindytsai.github.io/libyt/ +- **Documents**: https://yt-project.github.io/libyt/ +- **See `libyt` working progress**: [Project Board](https://github.com/yt-project/libyt/projects/1) diff --git a/doc/_config.yml b/doc/_config.yml index 45f280a1..a5ccd5f5 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -1,12 +1,12 @@ -title: libyt Documents (Dev) -description: libyt documents, this site is mainly for developing. +title: libyt Documents +description: libyt documents theme: just-the-docs -url: https://cindytsai.github.io/libyt/ +url: https://yt-project.github.io/libyt/ # Aux links for the upper right navigation, create new tab once click aux_links: - cindytsai/libyt (dev): https://github.com/cindytsai/libyt + yt-project/libyt GitHub : https://github.com/yt-project/libyt aux_links_new_tab: true # Heading anchor links appear on hover over h1-h6 tags in page content diff --git a/doc/index.md b/doc/index.md index bef94d4d..5f49bb80 100644 --- a/doc/index.md +++ b/doc/index.md @@ -4,7 +4,7 @@ title: Home nav_order: 1 --- -# libyt Documents (Dev) +# libyt Documents Version 0.1.0 {: .label }