Merge pull request #1164 from bch0w/repo_cleanup

main repo cleanup

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,74 @@
+name: "🐛 Bug Report"
+description: Create a new ticket for a bug.
+title: "🐛 [BUG] - <title>"
+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

README.md

@@ -27,31 +27,35 @@ 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
 
-[![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)
+[![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/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)
+[![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
 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)

run_this_example_PLEASE_DO_NOT_REMOVE.sh → 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`