Skip to content

Commit c7b5244

Browse files
committed
fixes. colors. links.
1 parent e170b6b commit c7b5244

15 files changed

+147
-62
lines changed

docs/assets/extra.css

Lines changed: 94 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600&display=swap');
2+
13
:root {
24
--md-primary-fg-color: #262829;
35
--md-primary-fg-color--light: #343a40;
@@ -11,11 +13,15 @@
1113
--md-default-bg-color--light: #282a2a;
1214
--md-default-bg-color--lighter: #313333;
1315
--md-default-bg-color--lightest: #3a3c3c;
16+
--md-code-bg-color: #1e2b38;
17+
--md-code-fg-color: #d0dde8;
1418
}
1519

1620
.md-header {
17-
background-color: #262829;
21+
background-color: #242627;
1822
color: #fff;
23+
border-bottom: 1px solid #333637;
24+
box-shadow: 0 1px 12px rgba(0, 0, 0, 0.35);
1925
}
2026

2127
.md-header a,
@@ -33,11 +39,16 @@ a {
3339
color: #c0995e;
3440
}
3541

42+
a:visited {
43+
color: #c0995e;
44+
}
45+
3646
a:hover {
3747
color: #d4b07a;
3848
}
3949

4050
.md-nav__link--active,
51+
.md-nav__link:visited,
4152
.md-nav__link:hover {
4253
color: #c0995e;
4354
}
@@ -52,10 +63,25 @@ a:hover {
5263
color: #c0995e;
5364
}
5465

66+
.md-typeset a:visited {
67+
color: #c0995e;
68+
}
69+
5570
.md-typeset a:hover {
5671
color: #d4b07a;
5772
}
5873

74+
.md-typeset a code,
75+
.md-typeset a:visited code {
76+
color: #c0995e;
77+
background-color: transparent;
78+
border-color: rgba(192, 153, 94, 0.3);
79+
}
80+
81+
.md-typeset a:hover code {
82+
color: #d4b07a;
83+
}
84+
5985
.md-header__button.md-logo {
6086
display: none;
6187
}
@@ -64,58 +90,106 @@ a:hover {
6490
display: none;
6591
}
6692

67-
/* Top navbar matching comp-physics.group Bootstrap navbar */
93+
/* Top navbar — mirrors comp-physics.group Bootstrap navbar exactly */
6894
.md-banner {
69-
background-color: #262829 !important;
70-
padding: 0 1rem;
95+
background-color: #242627 !important;
96+
border-bottom: 1px solid #333637;
97+
box-shadow: 0 1px 12px rgba(0, 0, 0, 0.35);
98+
padding: 0;
99+
}
100+
101+
/* Material wraps announce content in .md-banner__inner.md-grid.md-typeset —
102+
bust out of its max-width and padding so our navbar controls its own layout.
103+
Also reset font-size to 16px so rem units inside resolve correctly. */
104+
.md-banner__inner {
105+
max-width: 100% !important;
106+
padding: 0 1rem !important;
107+
margin: 0 !important;
108+
font-size: 16px !important;
71109
}
72110

111+
/* max-width container centred inside the full-width banner, brand left then links */
73112
.cp-navbar {
74113
display: flex;
75114
align-items: center;
76-
justify-content: center;
77-
width: 100%;
78-
height: 3.5rem;
79-
gap: 2rem;
115+
max-width: 1000px;
116+
margin: 0 auto;
117+
padding: 0.55rem 0;
118+
-webkit-font-smoothing: antialiased;
119+
-moz-osx-font-smoothing: grayscale;
80120
}
81121

82122
.cp-navbar-brand {
83123
display: flex;
84124
align-items: center;
85-
gap: 0.5rem;
86-
color: #fff !important;
125+
padding: 0.25rem 0;
126+
margin-right: 1.25rem;
127+
color: #cec6bc !important;
87128
text-decoration: none !important;
88-
font-size: 1rem;
129+
font-family: "IBM Plex Sans", sans-serif;
130+
font-size: 17.6px !important;
131+
font-weight: 600;
89132
white-space: nowrap;
133+
word-break: normal;
134+
overflow-wrap: normal;
135+
flex-shrink: 0;
136+
transition: color 0.18s ease;
90137
}
91138

92139
.cp-navbar-brand:hover {
93-
color: rgba(255,255,255,0.75) !important;
140+
color: #fff !important;
141+
text-decoration: none !important;
94142
}
95143

96144
.cp-navbar-brand img {
145+
margin-right: 5px;
97146
border-radius: 3px;
98147
}
99148

100149
.cp-navbar-links {
101150
display: flex;
102151
align-items: center;
103-
gap: 0.25rem;
104152
}
105153

106154
.cp-navbar-links a {
107155
color: #c0995e !important;
108156
text-decoration: none !important;
109-
font-size: 1rem;
110-
padding: 0.4rem 0.75rem;
111-
border-radius: 4px;
112-
transition: color 0.15s;
157+
font-family: "IBM Plex Sans", sans-serif;
158+
font-size: 16.8px !important;
159+
font-weight: 500;
160+
padding: 0.4rem 0.85rem;
161+
white-space: nowrap;
162+
word-break: normal;
163+
overflow-wrap: normal;
164+
transition: color 0.18s ease;
165+
position: relative;
166+
}
167+
168+
.cp-navbar-links a::after {
169+
content: '';
170+
position: absolute;
171+
bottom: 0;
172+
left: 0.85rem;
173+
right: 0.85rem;
174+
height: 2px;
175+
background: #c0995e;
176+
transform: scaleX(0);
177+
transition: transform 0.2s ease;
178+
border-radius: 1px;
179+
}
180+
181+
.cp-navbar-links a:hover,
182+
.cp-navbar-links a:focus {
183+
color: #d4b07c !important;
184+
text-decoration: none !important;
113185
}
114186

115-
.cp-navbar-links a:hover {
116-
color: #d4b07a !important;
187+
.cp-navbar-links a:hover::after,
188+
.cp-navbar-links a:focus::after,
189+
.cp-navbar-links a.cp-navbar-active::after {
190+
transform: scaleX(1);
117191
}
118192

119193
.cp-navbar-active {
120-
color: #d4b07a !important;
194+
color: #d4b07c !important;
121195
}

docs/group-syllabus/doing-research.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ This is important for your sense of progress, as the more challenging work might
5656
This is also important to get exposure for you and your ideas in wider venues.
5757

5858
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.
6060
It should take less than 1/2-1/3 of a day of your time per week.
6161
But you have something to offer and will be listed in a supporting author position.
6262
Also, of the lower-risk, lower-reward variety.
@@ -106,7 +106,7 @@ For example, the authors' methods, the way they asked their research questions,
106106
* When you read a good paper in your research area, ask yourself what should come next.
107107
What assumptions do they make?
108108
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?
110110
Identifying papers like that can impact your research directions over time.
111111

112112
* 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
134134
Similarly, students can pursue a project that I am less interested in, making me less engaged and less helpful as an advisor.
135135
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.
136136

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.
138138
If there's no overlap, one option is to switch advisors.
139139
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.
140140
This is normal and healthy.

docs/group-syllabus/faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If your question isn't answered here, please reach out to Spencer or other membe
1111
Our group focuses on developing computational models and numerical methods for physics problems.
1212
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.
1313
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.
1515

1616
### How do I join the group?
1717

@@ -32,8 +32,8 @@ It ebbs and flows, depending on the interest of the students.
3232

3333
### What software/programming languages should I know?
3434

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++.
3737
High-level languages are mostly up to you, though I prefer you use Python to maximize the reach of your software.
3838
Our group develops widely used open-source software like MFC, an exascale multi-phase flow solver.
3939

@@ -82,6 +82,6 @@ See [When and where of working](when-where-working.md) for more details.
8282

8383
Yes, taking breaks is important for maintaining productivity and mental health (at least for most folks).
8484
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.
8686
You may find yourself taking semi-vacations, where you aren't in town but find yourself doing some side-work for fun anyway.
8787
This is up to you.

docs/group-syllabus/figures.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Common guidelines are
131131
* A violation would be using such a color scheme for data that varies from 0 to 1
132132
* 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`.
133133
* 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.
135135
* 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.
136136

137137
## Coordinate direction arrow triad.
@@ -205,7 +205,7 @@ __An exception__ to the above is if the figure contains no text or equations, li
205205

206206
**Rule:** Use vector graphic formats (PDF, please) for all plots that involve text or equations.
207207

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)).
209209

210210
An excerpt from [Formatting your work](formatting.md).
211211

docs/group-syllabus/formatting.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ From [here](https://www.annaclemens.com/blog/figure-graph-data-vizualisation-plo
1919

2020
* Use LaTeX for all of your documents.
2121
* 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!
2323
* On my local computer, I like using `latexmk` for compilation.
2424
* __Put each sentence on one line of source `.tex` code__
2525

@@ -136,9 +136,10 @@ Some examples and common errors:
136136
* Not like this: _A Gaussian Moment Method and its Augmentation via LSTM Recurrent Neural Networks for the Statistics of Cavitating Bubble Populations_
137137
* And definitely not like this: _A gaussian moment method and its augmentation via lstm recurrent neural networks for the statistics of cavitating bubble populations_
138138
* 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+
```
142143
143144
* Book titles are usually capitalized as you enter them verbatim (capitalization and all) in the `.bib` file. So, be consistent when citing book titles!
144145
* Like this:
@@ -168,11 +169,14 @@ __Note__ the use of `\citep{ref}` and `\citet{ref}` here.
168169
Text `\citet{ref}` instances can be used as nouns but parenthetical references _cannot_.
169170

170171
* This is OK (via `\citet{ref}`):
172+
171173
> So and so [1] did this awesome thing.
174+
172175
* This is not (via `\citep{ref}`):
176+
173177
> [1] did this awesome thing.
174178
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.
176180
For example:
177181

178182
* This is correct: `The algorithm is fast, but not as fast as possible~\citep{ref}.`
@@ -181,17 +185,22 @@ For example:
181185
We generally want our references at the end of sentences unless they are part of a long list.
182186

183187
* Incorrect:
188+
184189
> The LBM method [1] is not as accurate as the finite volume method [2].
190+
185191
* 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+
187195
* And this is also acceptable
196+
188197
> Cavitation is seen in many engineering applications, including submarines [1], pumps [2], and medical devices [3].
189198
190199
## Creating your bibliography
191200

192201
* Use `bibtool` to remove unused entries from your bibliography (`.bib`) file
193202
* 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
195204
* 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)
196205
* Compile your document (I prefer `latexmk` for this, but a combination of `pdflatex` and `bibtex` also works).
197206
* Use the command `bibtool -r bibtool.config -x main.aux > test.bib`
@@ -254,7 +263,7 @@ First, labeling them appropriately as
254263
\label{e:lineareqn}
255264
\end{gather}
256265
```
257-
and then reference then via `cleveref`! As `\cref{e:lineareqn}`.
266+
and then reference them via `cleveref`! As `\cref{e:lineareqn}`.
258267

259268
Treat your equations as nouns, and never use the abbreviation "eqn." before it.
260269

docs/group-syllabus/funding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You also do not pay to attend conferences, this is covered via research funds.
1212
It is my role to make sure that you are supported by an RA, TA, or fellowship for as much of your Ph.D. as possible.
1313
Your Ph.D. program will require some (typically two) semesters of TA during your Ph.D., though you could be asked to do more of them.
1414

15-
RAs generally means some sort of grant or research award supports your work.
15+
RAs generally mean some sort of grant or research award supports your work.
1616
Again, it is my role to raise this money to support your research, or to fit your research into funding that I already have.
1717
It is also possible that later in the Ph.D. I will ask you (or you will initiate) for your help in writing a grant proposal in your area.
1818
This is good practice for you as a future scientist.

docs/group-syllabus/going-to-conferences.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Spencer is rather busy and does not have time to help you with your slides in th
8585
3. Prepare a nice visual slideshow/poster that keeps your audience engaged and interested in your work.
8686
Your goal is to make everyone read your papers and consider using your methods.
8787
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.
8989

9090
4. Before you go to the conference, check the session schedule and decide which ones you want to attend.
9191
Look for interesting papers and authors.

docs/group-syllabus/improving-your-writing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Such mistakes are a quick way for an editor or reviewer to perceive your work as
5858

5959
One should keep styles consistent within a manuscript.
6060
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.
6262
Note that this consistency extends to the level of detail throughout the paper.
6363
A detailed introduction is best matched with a results section that achieves a similar level of detail.
6464

@@ -105,7 +105,7 @@ You can consult replacement lists for common mistakes:
105105
These lists help me realize, "Hey, I write wordy phrases like this all the time!"
106106
Use the lists to learn the general ways one ends up with low information-density writing.
107107
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).
109109

110110
Conciseness can be viewed in a broader sense.
111111
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
148148
* Avoid redundancy. For example, use "investigate" instead of "conduct an investigation of".
149149
* Use active voice. Although not always possible, most text should be in an active voice.
150150
* 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.
152152
* Keep abbreviations to a minimum. Abbreviations are hard to read, consider just spelling it out.
153153
* Beware of zombie nouns. Utilization of nominalization is the causation of distraction.
154154

@@ -174,7 +174,7 @@ See, for example, the first figure in my paper, "Fast Macroscopic Forcing Method
174174
* Never use a foreign phrase, a scientific word, or a jargon word if you can think of an everyday English equivalent.
175175
* Break any of these rules sooner than say anything outright barbarous.
176176

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.'_
178178

179179
* 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?
180180

@@ -228,5 +228,5 @@ Over the years, I found the documents below helpful for improving my writing:
228228
* [Writing a science paper some dos and don'ts](https://www.elsevier.com/connect/writing-a-science-paper-some-dos-and-donts)
229229
* [Experimental Biosciences writing science](http://www.ruf.rice.edu/~bioslabs/tools/report/reportform.html)
230230
* [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.
232232
* [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

Comments
 (0)