Merge upstream master, add FAQ page

Author: sbryngelson

.github/PULL_REQUEST_TEMPLATE/default.md

@@ -0,0 +1,7 @@
+## Description
+
+<!-- Provide a brief description of the changes you're making -->
+
+## Related Issue(s)
+
+<!-- Link to any related issues (e.g., "Closes #123") -->

.github/workflows/linkchecker.yml

@@ -1,6 +1,8 @@
 name: LinkChecker
-
-on: push
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   markdown-link-check:

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to the Group Syllabus
+
+Thank you for considering contributing to our research group syllabus!
+This document provides guidelines for students and collaborators who want to suggest improvements, fix errors, or add new content.
+
+## Why Contribute?
+
+- **Improve the resource for everyone**: Your experiences and insights can help make this a better resource for current and future students.
+- **Develop your skills**: Contributing to documentation is valuable practice for academic and professional work.
+- **Build community**: Collaborative maintenance strengthens our research group.
+
+## How to Contribute
+
+### For Small Changes (Typos, Minor Clarifications)
+
+1. **Create an Issue**: 
+   - Go to the [Issues tab](https://github.com/comp-physics/group-docs/issues) and create a new issue
+   - Use a clear title and describe the change you're suggesting
+   - Label it appropriately (e.g., "typo", "clarification")
+
+2. **Direct Pull Request**:
+   - For simple changes, you can directly edit the file on GitHub
+   - Click the pencil icon on the file you want to edit
+   - Make your changes and create a pull request with a clear description
+
+### For Larger Contributions (New Content, Major Revisions)
+
+1. **Discuss First**:
+   - Create an issue describing what you'd like to add or change
+   - Wait for feedback before investing significant time
+
+2. **Fork and Clone**:
+   - Fork the repository to your GitHub account
+   - Clone it to your local machine
+   - Create a new branch for your changes
+
+3. **Make Changes**:
+   - Make your changes or additions
+   - Follow the existing style and formatting
+   - Add clear commit messages
+
+4. **Submit a Pull Request**:
+   - Push your changes to your fork
+   - Create a pull request to the main repository
+   - Provide a clear description of the changes and why they're valuable
+
+## Content Guidelines
+
+When contributing content, please follow these guidelines:
+
+1. **Be Clear and Concise**: Write in clear, straightforward language.
+2. **Be Accurate**: Verify information before submitting.
+3. **Follow Existing Structure**: Match the style and organization of existing documents.
+4. **Consider All Students**: Remember that this resource serves both PhD and undergraduate students.
+5. **Respect Confidentiality**: Don't include sensitive or private information.
+
+## Document Structure
+
+When creating or editing markdown files:
+
+- Use appropriate heading levels (# for title, ## for major sections, ### for subsections)
+- Include a table of contents for longer documents
+- Use bullet points and numbered lists for clarity
+- Link to other relevant documents when appropriate
+
+## Review Process
+
+After submitting a contribution:
+
+1. Spencer will review your submission
+2. You may receive feedback or requests for changes
+3. Once approved, your contribution will be merged
+
+## Getting Help
+
+If you're unsure about anything related to contributing:
+
+- Contact Spencer directly
+- Post a question in the group Slack channel
+
+## Recognition
+
+Contributors will be acknowledged in the repository. 
+
+Thank you for helping improve our group documentation! 

docs/group-syllabus/faq.md

@@ -0,0 +1,87 @@
+
+# Frequently Asked Questions
+
+This document addresses common questions that students and researchers in our group often have.
+If your question isn't answered here, please reach out to Spencer or other members.
+
+## General Questions
+
+### What is the focus of the Computational Physics Group?
+
+Our group focuses on developing computational models and numerical methods for physics problems.
+We accompany our methods with algorithms crafted to make efficient use of the latest exascale machines and computer architectures, including AMD GPUs, Arm/RISC CPUs, and quantum computers.
+We develop open-source software for these methods that scales to the world's largest supercomputers.
+Our work pushes applications forward in areas jet and rocket design, defense broadly, medical therapies and physiology, and the energy sector.
+
+### How do I join the group?
+
+Visit our website at https://comp-physics.group for information about openings.
+Messages to Spencer that do not follow the website instructions will be ignored.
+
+## Research and Collaboration
+
+### How are research projects assigned?
+
+Research projects are typically assigned based on a combination of the group's current research priorities, funding availability, your interests, and your skillset.
+We try to find a good match between these factors, and there's often room for you to propose your own ideas within our broader research themes.
+Our current research includes multiphase flow solvers, stochastic models for cell-scale flow, and information geometric regularization for extreme scale compressible flow simulation.
+
+### How often do we have group meetings?
+
+It ebbs and flows, depending on the interest of the students.
+
+### What software/programming languages should I know?
+
+Proficiency in one high-level and one-level language is important.
+We often use Fortran (free-form) as a low-level language, but new projects may be more ammenable to C/C++.
+High-level languages are mostly up to you, though I prefer you use Python to maximize the reach of your software.
+Our group develops widely used open-source software like MFC, an exascale multi-phase flow solver.
+
+## Academic Progress
+
+### What are the publication expectations?
+
+PhD students generally author or co-author 3-5 papers during the program, with 1 or 2 as first author.
+The quality of publications is valued over quantity.
+See the [Publishing](publishing.md) guide for more details.
+Our group regularly publishes in high-impact journals and conferences in computational physics, fluid dynamics, and related fields.
+
+### How do I know if I'm making good progress in my research?
+
+Feedback should be provided during one-on-one meetings, but if you have any questions or doubts you are *strongly encouraged* to talk to Spencer.
+Generally, good progress includes advancing your research questions, developing your technical skills, producing results (even negative ones), working toward publications, and __becoming an independent researcher that does not need Spencer__!
+Of course, I understand research has natural ebbs and flows.
+
+## Resources and Support
+
+### What computing resources are available?
+
+Our group has access to various computing resources, like Georgia Tech's PACE cluster and external supercomputing facilities.
+See [Available computers](computers.md) for specific information.
+
+### Is there funding for conferences?
+
+Yes, attending conferences is an important part of academic development.
+Funding is often available for students.
+See [Going to conferences](going-to-conferences.md) for the process of requesting conference funding.
+
+### What should I do if I'm struggling with my research or coursework?
+
+First, know that challenges are normal in research and graduate studies.
+Reach out to Spencer for research difficulties or course instructors for academic challenges.
+
+## Work-Life Balance
+
+### What are the expectations for working hours/days?
+
+I value productivity over specific hours worked.
+While I expect full-time commitment during normal workweeks for funded students, I'm flexible about when and where you work.
+See [When and where of working](when-where-working.md) for more details.
+
+### Can I take vacation time? How much?
+
+Yes, taking breaks is important for maintaining productivity and mental health (at least for most folks).
+Typically, students take 2-3 weeks of vacation per year, plus university holidays.
+This is flexible, so just talk to Spencer and coordinate with Spencer in advance, especially for longer absences.
+You may find yourself taking semi-vacations, where you aren't in town but find yourself doing some side-work for fun anyway.
+This is up to you.

docs/group-syllabus/formatting.md

@@ -102,6 +102,10 @@ Common errors
 * Do not use inline math with full fractions that make your text too small to read!
     * Don't do this (inline): $\frac{a}{b}$
     * Do this: $a/b$
+* Always use \left and \right for scalable delimiters around tall expressions like fractions or summations.
+    * Don't do this: $(1 + a(1 + \frac{a + b}{b}))$
+    * Do this: $\left(1 + a\left(1+ \frac{a + b}{b} \right) \right)$
+    * Note that in the incorrect version, the closing parenthesis is too small and does not scale to the height of the fraction
 
 ## Scientific notation and large/small numbers
 

docs/index.md

@@ -13,7 +13,7 @@ Welcome! This is the documentation for the Computational Physics research group
 [When and where of working](group-syllabus/when-where-working.md) ·
 [Going to conferences](group-syllabus/going-to-conferences.md) ·
 [Giving talks](group-syllabus/giving-talks.md) ·
-[Challenges](group-syllabus/challenges.md)
+[Challenges](group-syllabus/challenges.md) · [FAQ](group-syllabus/faq.md)
 
 **Papers and Writing** —
 [Academic writing](group-syllabus/improving-your-writing.md) ·

mkdocs.yml

@@ -53,6 +53,7 @@ nav:
     - Going to conferences: group-syllabus/going-to-conferences.md
     - Giving talks: group-syllabus/giving-talks.md
     - Challenges: group-syllabus/challenges.md
+    - FAQ: group-syllabus/faq.md
   - Papers and Writing:
     - Academic writing: group-syllabus/improving-your-writing.md
     - Formatting: group-syllabus/formatting.md