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

update MD files for software dev course #52

Merged
merged 10 commits into from
Oct 9, 2024

Conversation

SissiFeng
Copy link
Contributor

No description provided.

1. Download and install VS Code from the official site: [VS Code Download](https://code.visualstudio.com/).
2. Open VS Code and get familiar with the interface, including the command palette, sidebar, and settings menu.

**Video Tutorial**: [Getting Started with VS Code](https://www.youtube.com/watch?v=VqCgcpAypFQ)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@sgbaird sgbaird Sep 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback from you: original one is more beginner friendly

conda activate myenv
```

4. Ensure that VS Code is set up to use this environment for Python development.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably a good place to link to official VS code docs related to conda environments

docs/courses/software-dev/4.1-vscode-setup.md Show resolved Hide resolved
docs/courses/software-dev/4.1-vscode-setup.md Show resolved Hide resolved
#### Steps:

1. Install the **Remote - SSH** extension from the marketplace.
2. Set up SSH on your local machine by generating SSH keys:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually a bit confused here on the example it's being shown. Is the idea that your SSHing from your own machine to some other part of your machine? I wonder if there's another way to show the use of SSH relative to another platform, or at least point out an example. In my case I've used this extension a lot in the context of University high performance compute clusters and submitting SLURM jobs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usecase: Raspberry Pi ssh with VS Code extension. I'll get you an RPi 5 and a screen. Maybe mention HPC as a common example in physical sciences

docs/courses/software-dev/4.1-vscode-setup.md Show resolved Hide resolved

**Video Tutorial**: [VS Code Remote Development with SSH](https://www.youtube.com/watch?v=miyD4c1dnTU&pp=ygUjVlMgQ29kZSBSZW1vdGUgRGV2ZWxvcG1lbnQgd2l0aCBTU0g%3D)

### Configuring Black Formatter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still need to finish my review, but I'll come back to this

@sgbaird sgbaird changed the title update MD files update MD files for software dev course Sep 26, 2024
@sgbaird
Copy link
Member

sgbaird commented Oct 7, 2024

I forget if it was this one or the other PR that I still couldn't compile the docs with. I was able to for some of the other PRs though

@sgbaird sgbaird merged commit c6760fb into AccelerationConsortium:main Oct 9, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants