[EPIC] 2022 Needed Resources

[rocco8773]

This issue outlines the resources we need to put together and include in resources/...

1. Installing Python (pip/Anaconda)
2. Learning Python - @namurphy
3. Outline IDEs
   • Summary of IDEs - @rocco8773
   • Topics
     • Installing
     • git integration
     • add-ons
     • ...
   • PyCharm - @rocco8773
   • VSCode - @wdeshazer @qudsiramiz
   • Spyder (+git and/or GitHub Desktop) - @svincena @dschaffner
4. Terminals (Unix/MacOS/Windows)
   • Unix - @namurphy
   • MacOS - @namurphy
   • Windows - @wdeshazer
5. Virtual Envornments
   • @qudsiramiz @rocco8773
   • base off the 2021 documents: https://github.com/PlasmaPy/hack-week/blob/hack-week-2021/tutorials_and_notebooks/virtual_environments_tutorial.md
6. git & Github
   • probably software-carpentry with any additions from us

---

Other topics:

1. Jupyter notebooks
2. notebook on PlasmaPy
3. How to structure Python packages.
   • https://packaging.python.org/en/latest/
   • dunders __all__, __init__
   • changing the mindset from writing and running scripts to build a package of tools
4. How to get git...

[namurphy]

Topics for terminals

1. Introduction (probably ≲ 2 paragraphs)

• What is a CLI?
• Benefits of a CLI vs. a GUI
• What is the Unix shell?
• Different flavors: bash vs. zsh vs. xonsh

2. How to install and open terminals in different operating systems

• Windows (which option?)
• macOS
• Linux

4. Most common commands for navigating the shell (ls, cd, pwd, cp, mv, mkdir, rm, etc.)
5. Getting help (man, help, --help, etc.)
6. Further reading

[rocco8773]

Topics an IDE document should cover:

1. How to get it?
2. Installing
3. Configuring
   • Linking to GitHub
   • git integration
   • virtual environments
4. Key Features
5. Workflow (keep very top level...detail covered on Tuesday)
   • opening a project/repo (cloning repo)
   • make a change
   • commit
   • push
   • fetch
   • pull
   • editing/linters (maybe in Key Features)
   • breakpoints/debugging
   • built-in IPython terminals
   • honorary mentions
     • profiler tools
     • testing tools
     • testing coverage tools