diff --git a/docs/Policies/code_software.md b/docs/Policies/code_software.md index 3c97461..703e3f0 100644 --- a/docs/Policies/code_software.md +++ b/docs/Policies/code_software.md @@ -44,4 +44,7 @@ Patrick Mineault's code handbook above is a must-read before you start coding. I - Maintain good style. - This includes commenting, which should be done at the top of functions, classes, modules, files, etc. This helps both you and others understand code. - Pythonic code can be confusing sometimes; you'll need to make the tradeoff between clarity and brevity. - - Download a [linter](https://docs.astral.sh/ruff/) (e.g. Ruff) to help you format your code. \ No newline at end of file + - Download a [linter](https://docs.astral.sh/ruff/) (e.g. Ruff) to help you format your code. + +### VS Code +VS Code is a great IDE because it's open source (unlike e.g. PyCharm), highly customizable via extensions, and has great remote development support (which is important when working with the cluster). You can download it [here](https://code.visualstudio.com/Download). If you are unfamiliar with VS Code/IDEs in general, see the [VS Code tutorial](https://levensteinlab.github.io/Lab-Handbook/Resources/vs_code) for more info on how to get started. diff --git a/docs/Policies/conferences_workshops.md b/docs/Policies/conferences_workshops.md index fc8600c..bc1bf94 100644 --- a/docs/Policies/conferences_workshops.md +++ b/docs/Policies/conferences_workshops.md @@ -9,3 +9,5 @@ Please plan to **send me a draft of your abstract one week before deadline**. Th As with a paper submission, nothing goes out without all co-authors seeing and approving the final version. The exact number of conferences you should expect to present at per year will depend on your career stage, and status of your project. IMO the best times to present are when you're halfway through a project, and trying to figure out what the story is, and just after you've posted a preprint. + +See [Resources - Travel](https://levensteinlab.github.io/Lab-Handbook/Resources/travel/) for information on booking travel. diff --git a/docs/Policies/hours_remote_vacation.md b/docs/Policies/hours_remote_vacation.md index 33cd70f..c81286f 100644 --- a/docs/Policies/hours_remote_vacation.md +++ b/docs/Policies/hours_remote_vacation.md @@ -1,6 +1,6 @@ # Working hours, remote work, and vacation -As our work is predominantly theoretical/computational, we have a lot of flexibility around when and where we work. Please set your hours based on how you work best. I'm generally in lab ~930-~6, and I try to be as available as possible during that time. As our work is predominantly theoretical/computational, we have a lot of flexibility around when and where we work. Please set your hours based on how you work best. That being said, part of our job is being a contributing member to the lab community, and in my experience the spontaneous interactions we have here are some of the most impactful for the quality of our research. +As our work is predominantly theoretical/computational, we have a lot of flexibility around when and where we work. Please set your hours based on how you work best. That being said, part of our job is being a contributing member to the lab community, and in my experience the spontaneous interactions we have here are some of the most impactful for the quality of our research. I'm generally in lab ~930-~6, and I try to be as available as possible during that time. If it fits you, I would encourage you to plan one day a week where you work from home (or elsewhere out of office). This shift in perspective can be helpful for your work and I encourage you to take advantage of this time to think freely and critically about your project and current approaches. I do ask that you plan to attend lab meetings in person -- in my experience, remote attendance encourages people to listen (at best), rather than participate, in lab meetings. Also, I ask that you plan to be physically in lab 3-4 days a week. Of course, this can vary week to week and exceptions will be made to fit people’s circumstances. diff --git a/docs/Resources/debug_me.py b/docs/Resources/debug_me.py new file mode 100644 index 0000000..8a09db7 --- /dev/null +++ b/docs/Resources/debug_me.py @@ -0,0 +1,21 @@ +# debug_me.py +# A tiny script with an intentional bug to practice debugging in VS Code. + +# First, run the script normally to see the error. Then, set a breakpoint on the line +# with the division operation and run the debugger to inspect variables. + +def divide_numbers(a, b): + result = a / b + return result + +def main(): + numbers = [(10, 2), (5, 0), (8, 4)] + total = 0 + for x, y in numbers: + print(f"Dividing {x} by {y}") + total += divide_numbers(x, y) + + print("Average:", total / len(numbers)) + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/docs/Resources/travel.md b/docs/Resources/travel.md index 75758a4..4b34cef 100644 --- a/docs/Resources/travel.md +++ b/docs/Resources/travel.md @@ -1,3 +1,13 @@ To book travel and accommodation for conferences, use World Travel/Concur, Yale's platform for business travel. See [here](https://your.yale.edu/work-yale/campus-services/yale-travel-management) for more information. You can log into the Concur website [here](https://concur.yale.edu/). There is a training in Workday called ["Booking Federally Sponsored Travel with World Travel"](https://www.myworkday.com/yale/learning/course/1e7e093ab7a21001abc67bad56c90001?type=9882927d138b100019b928e75843018d&record=00f9b09f318e102c62781e428a3d0001) that you should complete in order to understand the restrictions on booking travel when using federal funds. + +You have a few options when it comes to airports: +- Bradley International Airport (BDL) in Hartford, CT: drive/Uber +- Newark International Airport (EWR) in Newark, NJ: direct Amtrak train from New Haven +- John F. Kennedy Airport (JFK) in Queens, NYC: Amtrak to LIRR or E train to AirTrain +- LaGuardia Airport (LGA) in Queens, NYC: Metro-North to Harlem-125th Street, then Uber or M60+ bus + +The three NYC airports (including EWR) are generally far cheaper and better connected. The direct Amtrak train from New Haven to Newark/EWR makes that the most convenient option. You can book Amtrak tickets in [Concur](https://concur.yale.edu/) (you should book them in advance) or use the [TrainTime App](https://www.mta.info/traintime) to buy Metro-North/LIRR tickets (less important to buy in advance). + +To navigate the MTA (NYC's public transit system) use Google Maps or e.g. CityMapper for real-time arrival info. The MTA has tap-to-pay terminals, so you can purchase a ticket on-site using your card or phone. \ No newline at end of file diff --git a/docs/Resources/vs_code.md b/docs/Resources/vs_code.md new file mode 100644 index 0000000..925e6e5 --- /dev/null +++ b/docs/Resources/vs_code.md @@ -0,0 +1,9 @@ +To get started with VS Code try a tutorial, such as [this one](https://code.visualstudio.com/docs/getstarted/getting-started). The program itself will also give you some tips. + +Some basic tips to get started: +1. Link VS Code with your GitHub account +2. Open a repository, such as `Lab-Handbook` +3. Try out the terminal (e.g. try `echo $SHELL` to see which shell your computer runs by default) +4. Install the Python extension +5. Create an environment +6. Use the debugger. You can copy `Resources/debug_me.py` to try it out! If you want, you can create a new project repo that you will also use for the pytorch tutorial as part of your first project. diff --git a/mkdocs.yml b/mkdocs.yml index 39576ee..e28e45c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,5 +22,6 @@ nav: - Doing Science: Resources/science_general.md - Travel: Resources/travel.md - VPN: Resources/vpn.md + - VS Code: Resources/vs_code.md - Onboarding: onboarding.md - Contact: contact.md