From ec2a9e3c7f3de9ee034b66e0bcba8c7fd8fbe846 Mon Sep 17 00:00:00 2001 From: Bryant Chow Date: Fri, 11 Nov 2022 13:18:53 -0900 Subject: [PATCH 1/4] removed long filenames from main repo, updated readme with warning about modifying configure script, updated main repo example docstring, updated web addresses to point to specfem org --- README.md | 16 ++++++++-------- ...gure_directly_here_is_what_to_do_instead.txt | 5 ----- ...EASE_DO_NOT_REMOVE.sh => run_this_example.sh | 10 ++++++++-- .../create_main_repo_example_movie.pdf | Bin 4 files changed, 16 insertions(+), 15 deletions(-) delete mode 100644 README_do_not_modify_configure_directly_here_is_what_to_do_instead.txt rename run_this_example_PLEASE_DO_NOT_REMOVE.sh => run_this_example.sh (73%) rename create_PDF_movie_of_the_results.sh => utils/create_main_repo_example_movie.pdf (100%) diff --git a/README.md b/README.md index 0426ed330..72e293419 100644 --- a/README.md +++ b/README.md @@ -30,20 +30,20 @@ and check the output files in `./OUTPUT_FILES/` ## Development -[![Actions Status](https://github.com/geodynamics/specfem2d/workflows/CI/badge.svg)](https://github.com/geodynamics/specfem2d/actions) -[![Travis Status](https://app.travis-ci.com/geodynamics/specfem2d.svg?branch=devel)](https://app.travis-ci.com/geodynamics/specfem2d) -[![Azure Status](https://dev.azure.com/danielpeter22/SPECFEM2D/_apis/build/status/geodynamics.specfem2d?branchName=devel)](https://dev.azure.com/danielpeter22/SPECFEM2D/_build/latest?definitionId=6&branchName=devel) -[![codecov](https://codecov.io/gh/geodynamics/specfem2d/branch/devel/graph/badge.svg)](https://codecov.io/gh/geodynamics/specfem2d) +[![Actions Status](https://github.com/specfem/specfem2d/workflows/CI/badge.svg)](https://github.com/specfem/specfem2d/actions) +[![Travis Status](https://app.travis-ci.com/specfem/specfem2d.svg?branch=devel)](https://app.travis-ci.com/specfem/specfem2d) +[![Azure Status](https://dev.azure.com/danielpeter22/SPECFEM2D/_apis/build/status/specfem.specfem2d?branchName=devel)](https://dev.azure.com/danielpeter22/SPECFEM2D/_build/latest?definitionId=6&branchName=devel) +[![codecov](https://codecov.io/gh/specfem/specfem2d/branch/devel/graph/badge.svg)](https://codecov.io/gh/specfem/specfem2d) [![Documentation Status](https://readthedocs.org/projects/specfem2d/badge/?version=latest)](https://specfem2d.readthedocs.io/en/latest/?badge=latest) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE) -* Actions tests: [github actions specfem2d](https://github.com/geodynamics/specfem2d/actions) +* Actions tests: [github actions specfem2d](https://github.com/specfem/specfem2d/actions) -* Travis tests: [travis-ci specfem2d](https://travis-ci.com/geodynamics/specfem2d/builds) +* Travis tests: [travis-ci specfem2d](https://travis-ci.com/specfem/specfem2d/builds) Development is hosted on GitHub in the -[geodynamics/specfem2d repository](https://github.com/geodynamics/specfem2d). +[geodynamics/specfem2d repository](https://github.com/specfem/specfem2d). SPECFEM2D is a community project that lives by the participation of its @@ -51,7 +51,7 @@ members — i.e., including you! It is our goal to build an inclusive and participatory community so we are happy that you are interested in participating! We have collected a set of guidelines and advice on how to get involved in the community and keep them in the specfem3d github wiki: -[specfem3d wiki](https://github.com/geodynamics/specfem3d/wiki) +[specfem3d wiki](https://github.com/specfem/specfem3d/wiki) ## Computational Infrastructure for Geodynamics (CIG) diff --git a/README_do_not_modify_configure_directly_here_is_what_to_do_instead.txt b/README_do_not_modify_configure_directly_here_is_what_to_do_instead.txt deleted file mode 100644 index 3015ecec3..000000000 --- a/README_do_not_modify_configure_directly_here_is_what_to_do_instead.txt +++ /dev/null @@ -1,5 +0,0 @@ - -Never modify the "configure" script directly, it is better to modify the "configure.ac" file and then generate the "configure" script by typing: - -autoreconf -i - diff --git a/run_this_example_PLEASE_DO_NOT_REMOVE.sh b/run_this_example.sh similarity index 73% rename from run_this_example_PLEASE_DO_NOT_REMOVE.sh rename to run_this_example.sh index 9dbfab909..637dce66b 100755 --- a/run_this_example_PLEASE_DO_NOT_REMOVE.sh +++ b/run_this_example.sh @@ -1,8 +1,14 @@ #!/bin/bash # -# this script runs the mesher and the solver (in serial or in parallel, as needed) -# using this example setup +# This script runs the main directory SPECFEM2D example problem, which is shown +# on the cover of the User Manual (https://specfem2d.readthedocs.io/en/latest/) # +# Under the hood it runs the mesher and the solver (in serial or parallel) for +# a multi-layered 2D domain with topography and a cavity. +# +# To create a movie of the results, have a look at the script: +# ./utils/create_main_repo_example_movie.sh +# echo "running example: `date`" currentdir=`pwd` diff --git a/create_PDF_movie_of_the_results.sh b/utils/create_main_repo_example_movie.pdf similarity index 100% rename from create_PDF_movie_of_the_results.sh rename to utils/create_main_repo_example_movie.pdf From 5ed773ceb45d19e2e46869768de931ee2bcf9c0f Mon Sep 17 00:00:00 2001 From: Bryant Chow Date: Fri, 11 Nov 2022 13:19:23 -0900 Subject: [PATCH 2/4] add github issue template --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 74 +++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 000000000..6564d7d48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,74 @@ +name: "🐛 Bug Report" +description: Create a new ticket for a bug. +title: "🐛 [BUG] - " +labels: [ + "bug" +] +body: + - type: textarea + id: description + attributes: + label: "Description" + description: Please enter an explicit description of your issue + placeholder: Short and explicit description of your incident... + validations: + required: true + - type: input + id: software-version + attributes: + label: "Affected SPECFEM2D version" + description: Please specify the exact version(s) of SPECFEM2D you use (version number, git commit id, or latest development version) + placeholder: + validations: + required: true + - type: input + id: environment + attributes: + label: "Your software and hardware environment" + description: Please specify the environment you are running SPECFEM2D in. In particular list your compiler (incl. version number), MPI (incl. version), and your hardware (laptop/desktop, cluster, gpu, etc.) + placeholder: + validations: + required: true + - type: textarea + id: reprod + attributes: + label: "Reproduction steps" + description: Please enter all the steps you did, so we can reproduce the issue + value: | + 1. Go to '...' + 2. Change settings '....' + 3. Use data files '....' + 4. See error + render: bash + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + value: | + ![DESCRIPTION](LINK.png) + render: bash + validations: + required: false + - type: textarea + id: logs + attributes: + label: "Logs" + description: Please copy and paste any relevant log output in particular the full error message (including your input). This will be automatically formatted into code, so no need for backticks. + render: bash + validations: + required: false + - type: dropdown + id: os + attributes: + label: "OS" + description: What is the impacted environment ? + multiple: true + options: + - Windows + - Linux + - Mac + validations: + required: false From 1ef64617e5b25d76f6fcd7c8fe28ec435cbe0342 Mon Sep 17 00:00:00 2001 From: Bryant Chow <bryant.h.c@gmail.com> Date: Fri, 11 Nov 2022 13:21:50 -0900 Subject: [PATCH 3/4] rolling back azure pipelines badge to working version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 72e293419..8d24235d4 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ and check the output files in `./OUTPUT_FILES/` [![Actions Status](https://github.com/specfem/specfem2d/workflows/CI/badge.svg)](https://github.com/specfem/specfem2d/actions) [![Travis Status](https://app.travis-ci.com/specfem/specfem2d.svg?branch=devel)](https://app.travis-ci.com/specfem/specfem2d) -[![Azure Status](https://dev.azure.com/danielpeter22/SPECFEM2D/_apis/build/status/specfem.specfem2d?branchName=devel)](https://dev.azure.com/danielpeter22/SPECFEM2D/_build/latest?definitionId=6&branchName=devel) +[![Azure Status](https://dev.azure.com/danielpeter22/SPECFEM2D/_apis/build/status/geodynamics.specfem2d?branchName=devel)](https://dev.azure.com/danielpeter22/SPECFEM2D/_build/latest?definitionId=6&branchName=devel) [![codecov](https://codecov.io/gh/specfem/specfem2d/branch/devel/graph/badge.svg)](https://codecov.io/gh/specfem/specfem2d) [![Documentation Status](https://readthedocs.org/projects/specfem2d/badge/?version=latest)](https://specfem2d.readthedocs.io/en/latest/?badge=latest) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE) From 623240ef7e727a90865505a15f1382ecbe8f24ca Mon Sep 17 00:00:00 2001 From: Bryant Chow <bryant.h.c@gmail.com> Date: Fri, 11 Nov 2022 13:23:22 -0900 Subject: [PATCH 4/4] added configure note to install instructions, previously located in now-deleted long-filename readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8d24235d4..98ed1920d 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,10 @@ make all ``` and check the output files in `./OUTPUT_FILES/` +>__NOTE__: Do not modify the 'configure' script directly. Please modify the + 'configure.ac' file instead, and generate a new 'configure' script with + the command: `autoreconf -i` + ## Development