Skip to content

Commit 5840fbf

Browse files
authored
Merge pull request #451 from katyhuff/2025-updates
2025 updates
2 parents 8021ed8 + 0be4bb2 commit 5840fbf

File tree

9 files changed

+76
-40
lines changed

9 files changed

+76
-40
lines changed

manual/guides/guides.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ that can be captured in one.
1616
# <a name="gettingstarted"></a>Getting Started
1717

1818
You're new to the research group. There are a lot of tasks to get done before
19-
you can really fly.
19+
you can really fly. When you start in the group, work with Prof. Huff to set up
20+
a GitHub Project with the following tasks designed as issues to get you
21+
started.
2022

2123
- Handle HR stuff.
2224
- Get a [GitHub](https://git-scm.com/book/en/v2/GitHub-Account-Setup-and-Configuration) account

manual/guides/katy/codereq.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ subtitle: "You have a bug. I am not your only hope."
55
permalink: /manual/guides/katy/codereq
66
---
77

8-
![Googling the Error Message](https://pbs.twimg.com/media/CfFPuvoWwAALmcC.jpg "The most important fake book of our time."){:width="270px"}
8+
![Googling the Error Message](https://raw.githubusercontent.com/denitdao/o-rly-collection/refs/heads/main/public/book_covers/google-error-message.jpg "The most important fake book of our time."){:width="270px"}
99
![Trying Stuff Until It Works](https://pbs.twimg.com/media/CfSQdwUW8AErog1.jpg:large "Another important fake book on persistence."){:width="270px"}
1010

11+
1112
# Google it
1213

1314
Please don't come to me with a question that can be solved by a Google search
14-
of the error. Especially if you are a Millenial from the U.S., Google really
15-
should be in your blood by now. For better google skills, consider
16-
[powering up your search tactics](http://www.powersearchingwithgoogle.com/course/aps/skills).
15+
of the error. In these modern times, Google really
16+
should be in your blood by now.
1717

18-
Once you google it, of course, try the things you found on google.
18+
Once you google it, of course, try the things you found on google, take notes,
19+
and read the errors for clues.
1920

2021
# Stack Overflow
2122

2223
If Google isn't sufficiently refined, or if your code issue isn't extremely
23-
urgent, consider asking your question on the largest programming bug forum in
24-
the solar system... [Stack Overflow](http://stackoverflow.com/). Be forewarned: the SO community
24+
urgent, consider asking your question on the largest programming bug forum in the solar system... [Stack Overflow](http://stackoverflow.com/). Be forewarned: the SO community
2525
is not always friendly or well-moderated for snark. That said, you can definitely improve your odds of kind
2626
answers by following [these tips on asking a question
2727
well.](http://stackoverflow.com/help/how-to-ask).
@@ -58,14 +58,29 @@ you will need to formulate a [Minimal Working
5858
Example.](http://stackoverflow.com/help/mcve)
5959

6060
Yes, sometimes a minimal working example is hard to create. If that's the case,
61-
I understand. However, you should still do what you can to document what you
62-
are trying to do, how you got where you are, how you tried to fix it. I will
63-
need this information to help you.
61+
I understand. However, simply the act of creating one is often enough to
62+
provide clues about the source of the error. As you proceed, please do what you
63+
can to document what you are trying to do, how you got where you are, how you
64+
tried to fix it. I will need this information to help you.
65+
66+
# Collaborate
67+
68+
You're probably in the office as you're doing your research, so you have an
69+
excellent resource very nearby! Your colleagues! You might just show them the
70+
error you're dealing with, or share your minimal working example on GitHub.
71+
Either way, try discussing it in person or on Slack with the other students,
72+
and maybe they can help.
6473

6574
# Contact me
6675

67-
If you have tried _everything_ above and nothing has been clarified, then
68-
should you email me. The email should include your minimal working example or
76+
There should be ample opportunities to ask me quick questions about what you
77+
can try to solve your bug -- try to drop by Coffee Chat or pop by my office if
78+
you think it'll only take a few minutes.
79+
80+
If you have tried _everything_ above and nothing has been clarified, and you
81+
think it might take a while to debut, then
82+
should you email me or Slack message me. If possible, it should point to details somewhere (ideally
83+
GitHub or a Gist) about your minimal working example or
6984
your detailed documentation of the problem (above). I may need a few days to
7085
look it over (so you may as well also add it to Stack Overflow in case they're
7186
faster than me.) If I can't help you fix it by email, I'll let you know we

manual/guides/katy/commreq.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ permalink: /manual/guides/katy/commreq
88
# Conditions
99

1010
- Your research should be something I can substantively comment on.
11-
- Please schedule all committee meetings well in advance (at least two months).
11+
- Please schedule all committee meetings well in advance (at least a few weeks)..
1212
- You must have a reproducibility plan for your research that describes how a
1313
scientist could reproduce your work. This may involve pointing to data,
1414
scripting analysis, version controlling all scripts you use in your work, and
1515
recording any details of software that you rely on.
1616
- You should provide me with yearly updates on your progress.
1717
- I will need at least two weeks to review any document under 100 pages. For
18-
documents over 100 pages, I will need one month.
18+
documents over 100 pages, I may need longer.
1919
- All documents should be provided in PDF format. If you happen to be version
2020
controlling the documents you are writing, I am happy to make line comments
2121
via GitHub.
22-
- If I don't know you well, I may ask to set up a meeting before agreeing to be
23-
on your committee.
22+
- If I don't know you or your research well, I may ask to set up a meeting
23+
before agreeing to be on your committee.
2424

2525
# Asking
2626

@@ -29,7 +29,7 @@ information. I'll need to know:
2929

3030
- Where I know you from.
3131
- Your advisor's name
32-
- Your topic
32+
- Your thesis topic
3333
- Your year in school
3434
- Your general timeline
3535
- Your expected graduation date

manual/guides/katy/meeting.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,35 @@ permalink: /manual/guides/katy/meeting
77

88
I look forward to speaking with you virtually or in person.
99

10+
# How
11+
12+
I am always open to discuss new ideas with
13+
colleagues, group members, students, and potential collaborators. My office
14+
door is often open for this reason. Feel free to pop by. However, if you'd like
15+
to schedule a meeting either virtually or in person, you're welcome to use the
16+
form described below.
17+
18+
1019
# When
1120

12-
If you are a student in my class, you should meet with me during my stated
13-
office hours for that course.
21+
Here's a url where you can pick a time and place that works for you:
22+
[katyhuff.youcanbook.me](http://katyhuff.youcanbook.me). This form works best
23+
for scheduling meetings that I've already agreed to (including office hours or
24+
student advising meetings). Please email to request a meeting if you think this
25+
booking might be a surprise to me.
1426

15-
For everyone else: here's a url where you can pick a time and place that works for you:
16-
[katyhuff.youcanbook.me](http://katyhuff.youcanbook.me). It syncs with my
17-
calendar. Once you've filled it out, we'll both receive an email that confirms
18-
the details.
27+
This web app syncs with my calendars. The default duration is 30 minutes. If
28+
you need to meet for longer, please change the duration at the top left hand
29+
side of the form. Once you've filled it out, we'll both receive an email that
30+
confirms the details.
1931

2032
- If it's 5 minutes, try dropping by my office.
2133
- If it's 15 minutes, schedule me for a 15 minute meeting.
2234
- If it's 30 minutes, schedule me for a 30 minute meeting and come prepared.
2335
- If it's longer than 30 minutes, are you sure?
2436

25-
# How
2637

27-
I look forward to meeting with you. I am always open to discuss new ideas with
28-
colleagues, group members, students, and potential collaborators. My office
29-
door is often open for this reason. However, please be aware that I
38+
However, please be aware that I
3039
think my office hours work most effectively if I arrive prepared. To get the
3140
most out of your time with me:
3241

manual/guides/katy/recreq.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ first whether I would be willing to support your application.
1414

1515
I am very happy to write a letter of reference for most people who:
1616

17-
- took at least one course from me
18-
- worked in my research group
19-
- collaborated with me or my research group
20-
- or interacted with me in some other way relevant to the application
17+
- took at least one course from me,
18+
- worked in my research group,
19+
- collaborated with me or my research group,
20+
- served on the UIUC ANS executive committee,
21+
- or interacted with me in some other way relevant to the application.
2122

2223
In all cases, I consider letter writing an exercise in integrity. I seek to be
2324
simultaneously as honest and generous as possible. Given this, please use your
@@ -33,8 +34,7 @@ information:
3334
- Please make your request well in advance (at least a few weeks) before it will be due.
3435
- Please don't forget to [write a professional email](http://chrisblattman.com/2010/11/08/students-how-to-email-to-your-professor-employer-and-professional-peers/).
3536

36-
I'm going to need some information.
37-
Most importantly, if I don't see you on a
37+
I'm going to need some information. Most importantly, if I don't see you on a
3838
daily basis, please remind me how we know one another and when we met (what
3939
year).
4040

manual/guides/software_templates.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,12 @@ that can be useful in software development. If your project falls under the
1717
range of capabilities they have you can save a lot of time by using them or
1818
adapting them to start your project.
1919

20-
## Shablona
20+
## Scientific Python Development Tools
21+
[learnscientificpython.org](https://learn.scientific-python.org/development/guides/packaging-simple/)
22+
has templates and tutorials guiding development of python packages using the
23+
most updated standards and norms in the scientific python community.
24+
25+
## Shablona
2126
[Shablona](https://github.com/uwescience/shablona) is a template repository that
2227
is designed for scientific python projects. The template comes with everything a
2328
small-scale project might need, and can be easily adapted for python projects.

manual/guides/writing/dissertation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ permalink: /manual/guides/writing/dissertation
1010
- The preliminary examination must be successful before dissertation writing
1111
can begin.
1212
- Create a repository to hold your dissertation during the writing process.
13-
- A UIUC template is available at:
13+
- A UIUC template is available in the ARFC GitHub organization.
1414
- Review an outline with your advisor.
1515
- Collect figures and tables. Arrange them to tell a story.
1616
- Determine a timeline for each chapter draft to be completed.

manual/guides/writing/ms-thesis.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ In Prof. Huff's experience, it is best to enable chapter-by-chapter review of yo
9999
A great way to do this with Prof. Huff is the following workflow:
100100

101101
- Note the [ms-thesis-template](https://github.com/arfc/ms-thesis-template) in the arfc github org.
102-
- Create a GitHub respository in your own GitHub user space (ideally, usetemplate).
102+
- Create a GitHub respository in the ARFC GitHub space (ideally, using the template).
103103
- Work on this document in your repository. Feel free to use feature branches
104104
and merge into master, or just commit directly to master as you go.
105-
- You need to give Prof. Huff collaborator permission on this repository to allow issue assignment.
105+
- If your MS repository is in your own GitHub user pace, then give Prof. Huff collaborator permission on this repository to allow issue assignment.
106106
- At some point, you decide that a part of your masters thesis is ready for
107107
Prof. Huff's review (e.g. the literature review chapter)
108108
- (optional) Tag the repository at that state. (e.g. ch1-draft-1)
@@ -125,6 +125,7 @@ Both the thesis advisor and the second reader should be given at least two weeks
125125

126126
## After Writing
127127

128+
- Check the NPRE and UIUC grad college websites for the most recent requirements.
128129
- Add yourself to the degree list.
129130
- Get the TDA form from Kristie.
130131
- Get Prof. Huff, the 2nd reader, and the NPRE department head to sign the

manual/guides/writing/prelim.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@ permalink: /manual/guides/writing/prelim
99

1010
Review the graduate handbook.
1111

12-
- fill ou the PhD Preliminary and Final Exam Proposal form available in the Student Services Office.
13-
- the students advisor and the department head must approve the thesis committee.
12+
13+
- Work out a plan, scope, and schedule, with Prof. Huff.
14+
- Fill out the PhD Preliminary and Final Exam Proposal form available in the Student Services Office.
15+
- Ensure that your advisor and the department head approve the thesis committee.
16+
- Set up a repository based on the UIUC dissertation template in the ARFC
17+
GitHub org.
1418

1519
## Rules of the Prelim
1620

0 commit comments

Comments
 (0)