Skip to content

Commit 1a284b3

Browse files
authored
Merge pull request #41 from sbryngelson/improve
2 parents 6573966 + 5c06c36 commit 1a284b3

File tree

1 file changed

+47
-33
lines changed

1 file changed

+47
-33
lines changed

readme.md

Lines changed: 47 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,68 @@
11
# Computational Physics @ GT Group Documentation
22

3-
* [Welcome to the group!](group-syllabus/intro-to-group.md)
3+
[![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc/4.0/)
4+
[![Georgia Tech](https://img.shields.io/badge/Georgia%20Tech-Computational%20Physics-b3a369)](https://comp-physics.group)
5+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
46

5-
## Syllabus
7+
Welcome to the Computational Physics @ GT Group Documentation! This repository contains guidelines, expectations, and resources for group members.
68

7-
* [Why a Ph.D.?](group-syllabus/why-phd.md)
8-
* [Funding](group-syllabus/funding.md)
9-
* [Working with me](group-syllabus/working-with-me.md)
10-
* [Doing research](group-syllabus/doing-research.md)
11-
* [Publishing](group-syllabus/publishing.md)
12-
* [When and where of working](group-syllabus/when-where-working.md)
13-
* [Going to conferences](group-syllabus/going-to-conferences.md)
14-
* [Giving talks](group-syllabus/giving-talks.md)
15-
* [Challenges](group-syllabus/challenges.md)
9+
## 📚 Quick Navigation
1610

17-
## Papers and Writing
11+
- [Welcome to the group!](group-syllabus/intro-to-group.md)
12+
- [FAQ - Frequently Asked Questions](group-syllabus/faq.md)
13+
- [Research Process Diagrams](group-syllabus/research-process.md)
14+
- [PhD Timeline & Milestones](group-syllabus/phd-timeline.md)
1815

19-
* [Academic writing](group-syllabus/improving-your-writing.md)
20-
* [Formatting your documents](group-syllabus/formatting.md)
21-
* [Making figures](group-syllabus/figures.md)
22-
* [Responding to reviewers](group-syllabus/responding-to-reviewers.md)
16+
## 🎓 Syllabus
2317

24-
## Details
18+
| Topic | Description |
19+
|-------|-------------|
20+
| [Why a Ph.D.?](group-syllabus/why-phd.md) | Understanding the purpose and value of doctoral studies |
21+
| [Funding](group-syllabus/funding.md) | Information about funding sources and expectations |
22+
| [Working with me](group-syllabus/working-with-me.md) | Expectations and guidelines for advisor-student relationship |
23+
| [Doing research](group-syllabus/doing-research.md) | Approaches to computational physics research |
24+
| [Publishing](group-syllabus/publishing.md) | Guidelines for academic publishing |
25+
| [When and where of working](group-syllabus/when-where-working.md) | Expectations about work schedule and location |
26+
| [Going to conferences](group-syllabus/going-to-conferences.md) | How to prepare for and attend academic conferences |
27+
| [Giving talks](group-syllabus/giving-talks.md) | Guidelines for effective research presentations |
28+
| [Challenges](group-syllabus/challenges.md) | Common challenges and how to address them |
2529

26-
* [Undergraduate specifics](group-syllabus/undergraduate-specifics.md)
27-
* [Available computers](group-syllabus/computers.md)
28-
* [Whose hardware is this, anyway?](group-syllabus/hardware.md)
30+
## ✍️ Papers and Writing
2931

30-
## Resources
32+
| Resource | Description |
33+
|----------|-------------|
34+
| [Academic writing](group-syllabus/improving-your-writing.md) | Improving your scientific writing skills |
35+
| [Formatting your documents](group-syllabus/formatting.md) | Standards for document formatting |
36+
| [Making figures](group-syllabus/figures.md) | Creating effective scientific figures |
37+
| [Responding to reviewers](group-syllabus/responding-to-reviewers.md) | How to handle peer review feedback |
3138

32-
* [FAQ - Frequently Asked Questions](group-syllabus/faq.md)
39+
## 💻 Details
3340

34-
## Templates
41+
| Resource | Description |
42+
|----------|-------------|
43+
| [Undergraduate specifics](group-syllabus/undergraduate-specifics.md) | Information specific to undergraduate researchers |
44+
| [Available computers](group-syllabus/computers.md) | Computing resources available to group members |
45+
| [Whose hardware is this, anyway?](group-syllabus/hardware.md) | Hardware ownership and policies |
3546

36-
* [For papers](templates/paper)
37-
* [For responses to paper reviews](templates/paper_rebuttal)
38-
* [For figures](templates/paper/figures)
39-
* [For talks](templates/talks)
47+
## 📝 Templates
4048

41-
## Contributing
49+
| Template | Description |
50+
|----------|-------------|
51+
| [For papers](templates/paper) | Templates for academic papers |
52+
| [For responses to paper reviews](templates/paper_rebuttal) | Templates for responding to reviewers |
53+
| [For figures](templates/paper/figures) | Templates for creating figures |
54+
| [For talks](templates/talks) | Templates for presentations |
4255

43-
This repository is designed to be collaborative.
44-
Current and former students are encouraged to contribute improvements, corrections, and additions based on their experiences.
56+
## 🤝 Contributing
57+
58+
This repository is designed to be collaborative. Current and former students are encouraged to contribute improvements, corrections, and additions based on their experiences.
4559

4660
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to suggest changes or add content.
4761

48-
## Acknowledgements
62+
## 👏 Acknowledgements
4963

5064
Parts of this are borrowed, heavily edited, from the Ph.D. syllabi of [Eric Gilbert](https://docs.google.com/document/d/11D3kHElzS2HQxTwPqcaTnU5HCJ8WGE5brTXI4KLf4dM) and Mor Maaman.
5165

52-
## License
66+
## 📄 License
5367

54-
CC BY-NC 4.0
68+
[CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) - Creative Commons Attribution-NonCommercial 4.0 International

0 commit comments

Comments
 (0)