Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to using VS Code #262

Open
anenadic opened this issue Nov 7, 2023 · 7 comments
Open

Switch to using VS Code #262

anenadic opened this issue Nov 7, 2023 · 7 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@anenadic
Copy link
Collaborator

anenadic commented Nov 7, 2023

Rework the lesson material to use VS Code. Check that we have all the functionality available to us before the switch.

@anenadic anenadic self-assigned this Nov 7, 2023
@anenadic anenadic added this to the December2023-beta milestone Nov 7, 2023
@anenadic
Copy link
Collaborator Author

anenadic commented Nov 9, 2023

What do the others think, should we make a push and switch to VSCode sooner (e.g. for the December release) rather than later? Your votes please @kkh451 @steve-crouch @bielsnohr @douglowe?

@anenadic
Copy link
Collaborator Author

anenadic commented Nov 9, 2023

From conversation with Steve 2023-11-09 - resources on using VS Code from SABS CDT:

Setup:
Once Ubuntu is installed, log in and open a command-line terminal. Install the required software via apt by typing in the following command:
sudo apt install -y python3-pip python3-venv python3-dev build-essential git
Then install VSCode using snap:
sudo snap install --classic code
Once VSCode has installed, run it and install the following extensions:

  • Python (Microsoft)
  • GitLens (optional)

IDEs: https://www.uhpc-training.co.uk/material/technology_and_tooling/ide/python
Testing (command line only): https://www.uhpc-training.co.uk/material/technology_and_tooling/testing/automated_testing
Scaling up: https://www.uhpc-training.co.uk/material/technology_and_tooling/testing/scaling_up
Debugging (and testing) both in vscode: https://www.uhpc-training.co.uk/material/technology_and_tooling/testing/diagnosing_issues

@bielsnohr
Copy link
Collaborator

bielsnohr commented Nov 9, 2023

My vote would be to not make this a priority for the December release. I need to find the data (think it is either the Python developer survey or Stackoverflow one) but PyCharm and VS Code are about equally popular for Python developers according to that. Where VS Code wins out is that it can be used for basically any language, and perhaps that is why we get more people requesting it.

Therefore, I think my preferred situation would be to have seamless selection of VS Code or PyCharm throughout the material. You see it on many websites where there is a tab/toggle at the top that switches certain portions of the content.

That might be a lot of overhead, but I think it will then cover a much broader reach of course participants. However, if we think the overhead is too much, that is understandable.

In my experience teaching, learners have been mostly fine looking at the "Extras" material when they need to figure out things for VS Code. We do occasionally get a few comments that it is a bit disruptive to need to switch frequently during the PyCharm heavy portions of the material, but that ends relatively quickly.

@anenadic
Copy link
Collaborator Author

anenadic commented Nov 10, 2023

My vote would be to not make this a priority for the December release. I need to find the data (think it is either the Python developer survey or Stackoverflow one) but PyCharm and VS Code are about equally popular for Python developers according to that. Where VS Code wins out is that it can be used for basically any language, and perhaps that is why we get more people requesting it.

Indeed - Steve and I were talking exactly about this - teaching the principles and not the tool and VS Code perhaps wins here.

Therefore, I think my preferred situation would be to have seamless selection of VS Code or PyCharm throughout the material. You see it on many websites where there is a tab/toggle at the top that switches certain portions of the content.

Also talked about that with Steve and what to do with the PyCharm version (do we split the repo, how to maintain, overheads of it all) - it would be ideal to be able to toggle but it is not easily doable in the current lesson format and definitely not for the December release.

That might be a lot of overhead, but I think it will then cover a much broader reach of course participants. However, if we think the overhead is too much, that is understandable.

In my experience teaching, learners have been mostly fine looking at the "Extras" material when they need to figure out things for VS Code. We do occasionally get a few comments that it is a bit disruptive to need to switch frequently during the PyCharm heavy portions of the material, but that ends relatively quickly.

Thank you for the feedback @bielsnohr - having some concrete usage numbers on PyCharm vs VS Code would be great (I have been mainly receiving requests for VS Code).

Latest update from 2023-11-09 is that Ann Gledson from Manchester and @douglowe's team has been looking into redoing the NERC version of the course using VS Code so we may get some effort from Ann - I said I'd be in touch with her and perhaps try and help her instead of both of us doing the same job. Will keep you all posted - this is definitely a big job and perhaps best left for the release after the December beta.

@bielsnohr
Copy link
Collaborator

This is the data I was referrring to:

image

It comes from the Python Developer Survey. VS Code marginally in more use.

However, the usage figures are more stark outside of Python, where VS Code is the clear favorite: https://survey.stackoverflow.co/2023/#section-most-popular-technologies-integrated-development-environment

@anenadic
Copy link
Collaborator Author

anenadic commented Nov 10, 2023

That's great @bielsnohr - good to have some data to back up the decision, thank you.

@douglowe
Copy link
Collaborator

Interesting to see the numbers on IDE preferences :)

As Aleks has said - we are looking to move to VS Code for our course in March. I'm very happy for us to be guinea-pigs in the conversion of the material from pycharm to VS Code. I do like the suggestion of having tabbed sections where the use of each would differ - as long as these aren't too long. So it will be useful for decision making on this to see how much of a change we have to make to our course material to accomodate VS Code - that can guide us as to how we might want to approach it for the main course too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants