You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/group-syllabus/doing-research.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ This is important for your sense of progress, as the more challenging work might
56
56
This is also important to get exposure for you and your ideas in wider venues.
57
57
58
58
3. Concurrently, try to be a supporting author on at least one other project.
59
-
This isn't your core work; it's someone else-led.
59
+
This isn't your core work; it's led by someone else.
60
60
It should take less than 1/2-1/3 of a day of your time per week.
61
61
But you have something to offer and will be listed in a supporting author position.
62
62
Also, of the lower-risk, lower-reward variety.
@@ -106,7 +106,7 @@ For example, the authors' methods, the way they asked their research questions,
106
106
* When you read a good paper in your research area, ask yourself what should come next.
107
107
What assumptions do they make?
108
108
What would make this even better?
109
-
What are the authors missing that is not an immediate "future work" for that scholar's arc?
109
+
What are the authors missing that is not an immediate "future work" for that scholar's arc?
110
110
Identifying papers like that can impact your research directions over time.
111
111
112
112
* Many phenomena we see online and around technology are not, strictly speaking, new.
@@ -134,7 +134,7 @@ If the student is not excited and motivated about a research direction, the outc
134
134
Similarly, students can pursue a project that I am less interested in, making me less engaged and less helpful as an advisor.
135
135
The process of coming up with ideas, research questions, and project decisions thus naturally gravitates towards mutually interesting directions that overlap with existing or potential funding.
136
136
137
-
At the same time, "interest splits" happen, and students often pursue questions and directions.
137
+
At the same time, "interest splits" happen, and students often pursue questions and directions independently.
138
138
If there's no overlap, one option is to switch advisors.
139
139
I have had students leave me to work with other advisors as it became clear that their pursuit and intellectual passion do not overlap with mine.
Copy file name to clipboardExpand all lines: docs/group-syllabus/faq.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ If your question isn't answered here, please reach out to Spencer or other membe
11
11
Our group focuses on developing computational models and numerical methods for physics problems.
12
12
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.
13
13
We develop open-source software for these methods that scales to the world's largest supercomputers.
14
-
Our work pushes applications forward in areas jet and rocket design, defense broadly, medical therapies and physiology, and the energy sector.
14
+
Our work pushes applications forward in areas of jet and rocket design, defense broadly, medical therapies and physiology, and the energy sector.
15
15
16
16
### How do I join the group?
17
17
@@ -32,8 +32,8 @@ It ebbs and flows, depending on the interest of the students.
32
32
33
33
### What software/programming languages should I know?
34
34
35
-
Proficiency in one high-level and one-level language is important.
36
-
We often use Fortran (free-form) as a low-level language, but new projects may be more ammenable to C/C++.
35
+
Proficiency in one high-level and one low-level language is important.
36
+
We often use Fortran (free-form) as a low-level language, but new projects may be more amenable to C/C++.
37
37
High-level languages are mostly up to you, though I prefer you use Python to maximize the reach of your software.
38
38
Our group develops widely used open-source software like MFC, an exascale multi-phase flow solver.
39
39
@@ -82,6 +82,6 @@ See [When and where of working](when-where-working.md) for more details.
82
82
83
83
Yes, taking breaks is important for maintaining productivity and mental health (at least for most folks).
84
84
Typically, students take 2-3 weeks of vacation per year, plus university holidays.
85
-
This is flexible, so just talk to Spencer and coordinate with Spencer in advance, especially for longer absences.
85
+
This is flexible, so just talk to Spencer and coordinate in advance, especially for longer absences.
86
86
You may find yourself taking semi-vacations, where you aren't in town but find yourself doing some side-work for fun anyway.
Copy file name to clipboardExpand all lines: docs/group-syllabus/figures.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,7 +131,7 @@ Common guidelines are
131
131
* A violation would be using such a color scheme for data that varies from 0 to 1
132
132
* In 2D settings, Paraview uses, by default, a lighting scheme that modifies the colors, including making white appear sand colored. Alleviate this by going to `View -> Light inspector` and deselect `Light Kit`.
133
133
* Adjust the RGB values of the color bar to let the unique/special value be exactly white if the data is centered at the unique/special value.
134
-
*Using a monochromatic color scheme (e.g., from white to black) for data that vary uniformly as above, say from 0 to 1.
134
+
*Use a monochromatic color scheme (e.g., from white to black) for data that vary uniformly as above, say from 0 to 1.
135
135
* Use a tri-color scheme that centers the color at black or white, e.g., the Paraview default red-white-blue for nominally centered data at a special or reference value, like 0 or 1.
136
136
137
137
## Coordinate direction arrow triad.
@@ -205,7 +205,7 @@ __An exception__ to the above is if the figure contains no text or equations, li
205
205
206
206
**Rule:** Use vector graphic formats (PDF, please) for all plots that involve text or equations.
207
207
208
-
**Rule:** Use the same color palette for all of your figures (not including flow visualizations) and your main text (see [formatting](formatting.md)]).
208
+
**Rule:** Use the same color palette for all of your figures (not including flow visualizations) and your main text (see [formatting](formatting.md)).
209
209
210
210
An excerpt from [Formatting your work](formatting.md).
Copy file name to clipboardExpand all lines: docs/group-syllabus/formatting.md
+17-8Lines changed: 17 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ From [here](https://www.annaclemens.com/blog/figure-graph-data-vizualisation-plo
19
19
20
20
* Use LaTeX for all of your documents.
21
21
* Make sure your documents _do not_ compile with errors, especially if you are using Overleaf!
22
-
* If you have warnings, understand where they warnings come from. They may be signaling something important!
22
+
* If you have warnings, understand where those warnings come from. They may be signaling something important!
23
23
* On my local computer, I like using `latexmk` for compilation.
24
24
*__Put each sentence on one line of source `.tex` code__
25
25
@@ -136,9 +136,10 @@ Some examples and common errors:
136
136
* Not like this: _A Gaussian Moment Method and its Augmentation via LSTM Recurrent Neural Networks for the Statistics of Cavitating Bubble Populations_
137
137
* And definitely not like this: _A gaussian moment method and its augmentation via lstm recurrent neural networks for the statistics of cavitating bubble populations_
138
138
* Accomplish this via the `.bib` entry, like this
139
-
```tex
140
-
title = {A {G}aussian moment method and its augmentation via {LSTM} recurrent neural networks for the statistics of cavitating bubble populations},
141
-
```
139
+
140
+
```tex
141
+
title = {A {G}aussian moment method and its augmentation via {LSTM} recurrent neural networks for the statistics of cavitating bubble populations},
142
+
```
142
143
143
144
* Book titles are usually capitalized as you enter them verbatim (capitalization and all) in the `.bib` file. So, be consistent when citing book titles!
144
145
* Like this:
@@ -168,11 +169,14 @@ __Note__ the use of `\citep{ref}` and `\citet{ref}` here.
168
169
Text `\citet{ref}` instances can be used as nouns but parenthetical references _cannot_.
169
170
170
171
* This is OK (via `\citet{ref}`):
172
+
171
173
> So and so [1] did this awesome thing.
174
+
172
175
* This is not (via `\citep{ref}`):
176
+
173
177
> [1] did this awesome thing.
174
178
175
-
Always prevent line-breaks via tides`~` between a parenthetical reference and the text before it.
179
+
Always prevent line-breaks via tildes`~` between a parenthetical reference and the text before it.
176
180
For example:
177
181
178
182
* This is correct: `The algorithm is fast, but not as fast as possible~\citep{ref}.`
@@ -181,17 +185,22 @@ For example:
181
185
We generally want our references at the end of sentences unless they are part of a long list.
182
186
183
187
* Incorrect:
188
+
184
189
> The LBM method [1] is not as accurate as the finite volume method [2].
190
+
185
191
* Correct:
186
-
> The LBM method is described in So and So [1]. However, is not as accurate as the finite volume method [2].
192
+
193
+
> The LBM method is described in So and So [1]. However, it is not as accurate as the finite volume method [2].
194
+
187
195
* And this is also acceptable
196
+
188
197
> Cavitation is seen in many engineering applications, including submarines [1], pumps [2], and medical devices [3].
189
198
190
199
## Creating your bibliography
191
200
192
201
* Use `bibtool` to remove unused entries from your bibliography (`.bib`) file
193
202
* Remove all unused bibliography entries from your `.bib` file. To do this,
194
-
* Make sure you have `bibtool` installed your your system
203
+
* Make sure you have `bibtool` installed on your system
195
204
* Copy a `bibtool.config` file to your document path, mine is located [here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/bibtool.config)
196
205
* Compile your document (I prefer `latexmk` for this, but a combination of `pdflatex` and `bibtex` also works).
197
206
* Use the command `bibtool -r bibtool.config -x main.aux > test.bib`
@@ -254,7 +263,7 @@ First, labeling them appropriately as
254
263
\label{e:lineareqn}
255
264
\end{gather}
256
265
```
257
-
and then reference then via `cleveref`! As `\cref{e:lineareqn}`.
266
+
and then reference them via `cleveref`! As `\cref{e:lineareqn}`.
258
267
259
268
Treat your equations as nouns, and never use the abbreviation "eqn." before it.
Copy file name to clipboardExpand all lines: docs/group-syllabus/going-to-conferences.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ Spencer is rather busy and does not have time to help you with your slides in th
85
85
3. Prepare a nice visual slideshow/poster that keeps your audience engaged and interested in your work.
86
86
Your goal is to make everyone read your papers and consider using your methods.
87
87
Practice your presentation multiple times; I recommend at least 10 practice talks with yourself.
88
-
__Don't wait until the last minute to do this:__ The conference is a time for listening to other people's presentations and making connections, not for practicing your presentation or doing homework.
88
+
__Don't wait until the last minute to do this:__ The conference is a time for listening to other people's presentations and making connections, not for practicing your presentation or doing homework.
89
89
90
90
4. Before you go to the conference, check the session schedule and decide which ones you want to attend.
Copy file name to clipboardExpand all lines: docs/group-syllabus/improving-your-writing.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ Such mistakes are a quick way for an editor or reviewer to perceive your work as
58
58
59
59
One should keep styles consistent within a manuscript.
60
60
You might be forgiven for even poor style choices if you are consistent.
61
-
Please look at the [these](formatting.md) documents for more.
61
+
Please look at [these](formatting.md) documents for more.
62
62
Note that this consistency extends to the level of detail throughout the paper.
63
63
A detailed introduction is best matched with a results section that achieves a similar level of detail.
64
64
@@ -105,7 +105,7 @@ You can consult replacement lists for common mistakes:
105
105
These lists help me realize, "Hey, I write wordy phrases like this all the time!"
106
106
Use the lists to learn the general ways one ends up with low information-density writing.
107
107
You can then identify similar phrases in your writing.
108
-
Often, eliminating them is relatively easy, but noticing them is (at first).
108
+
Often, eliminating them is relatively easy, but noticing them is hard (at first).
109
109
110
110
Conciseness can be viewed in a broader sense.
111
111
For example, you should structure your paragraphs such that you aren't repeating information.
@@ -148,7 +148,7 @@ See, for example, the first figure in my paper, "Fast Macroscopic Forcing Method
148
148
* Avoid redundancy. For example, use "investigate" instead of "conduct an investigation of".
149
149
* Use active voice. Although not always possible, most text should be in an active voice.
150
150
* Avoid inappropriate language. Keep words like "really, actually, pretty much" for social networks.
151
-
* Avoid rare words and latinisms. Non credo all readers know the meaning.
151
+
* Avoid rare words and latinisms. Not all readers know the meaning.
152
152
* Keep abbreviations to a minimum. Abbreviations are hard to read, consider just spelling it out.
153
153
* Beware of zombie nouns. Utilization of nominalization is the causation of distraction.
154
154
@@ -174,7 +174,7 @@ See, for example, the first figure in my paper, "Fast Macroscopic Forcing Method
174
174
* Never use a foreign phrase, a scientific word, or a jargon word if you can think of an everyday English equivalent.
175
175
* Break any of these rules sooner than say anything outright barbarous.
176
176
177
-
* Kill your darlings. Sometimes, you'll write a so elegant and well-crafted phrase that it jars with the rest of your writing and pulls the reader out of the flow. So cut it. As Stephen King once put it: _'Kill your darlings, kill your darlings, even when it breaks your egocentric little scribbler's heart, kill your darlings.'_
177
+
* Kill your darlings. Sometimes, you'll write such an elegant and well-crafted phrase that it jars with the rest of your writing and pulls the reader out of the flow. So cut it. As Stephen King once put it: _'Kill your darlings, kill your darlings, even when it breaks your egocentric little scribbler's heart, kill your darlings.'_
178
178
179
179
* If you want to describe a figure/table in the results text, it can help to imagine you're giving a seminar. What features would you draw your audience's attention to? What would you tell people about during coffee break?
180
180
@@ -228,5 +228,5 @@ Over the years, I found the documents below helpful for improving my writing:
228
228
*[Writing a science paper some dos and don'ts](https://www.elsevier.com/connect/writing-a-science-paper-some-dos-and-donts)
*[11 steps to structuring a science paper editors will take seriously](https://www.elsevier.com/connect/11-steps-to-structuring-a-science-paper-editors-will-take-seriously)
231
-
*[Strunk and Write](https://www.amazon.com/Elements-Style-Fourth-William-Strunk/dp/020530902X) is a classical book that describes common writing gaffs and style particulars.
231
+
*[Strunk and White](https://www.amazon.com/Elements-Style-Fourth-William-Strunk/dp/020530902X) is a classical book that describes common writing gaffs and style particulars.
232
232
*[Move over Strunk and White: My all-time favorite books on writing](https://clauswilke.com/blog/2017/11/12/move-over-strunk-and-white/)
0 commit comments