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

[DOC] Update computing section #73

Merged
merged 17 commits into from
Jun 12, 2024
Merged

Conversation

emdupre
Copy link
Contributor

@emdupre emdupre commented May 2, 2024

Closes #61.

Expands computing documentation to better serve as an internal resource.
cc @ebridge2

@emdupre emdupre marked this pull request as ready for review May 14, 2024 22:25
@emdupre
Copy link
Contributor Author

emdupre commented May 14, 2024

This is now ready for review @poldrack !

Copy link
Contributor

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Pushed a few changes that I think should be uncontroversial.

Overall, this LGTM, but might be good to get someone with more day-to-day sherlock usage to give it a once-over.

labguide/computing/tacc.md Outdated Show resolved Hide resolved
labguide/computing/sherlock/data-management.md Outdated Show resolved Hide resolved
@emdupre
Copy link
Contributor Author

emdupre commented Jun 12, 2024

@ebridge2 and @effigies ; I've now streamlined the "access and resources" and "data management" sections. The diff looks bigger than it is, since now all sentences are on newlines !

I ended up not cross-linking the sections since they feel relatively self-contained now, but very happy for other opinions here. Thanks !

Comment on lines 67 to 71
To use `ncdu`, add the following line to the bottom of your `~/.bash_profile`, which will load the `ncdu` module each time you log in to Sherlock:

```bash
$ ml system ncdu
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To use `ncdu`, add the following line to the bottom of your `~/.bash_profile`, which will load the `ncdu` module each time you log in to Sherlock:
```bash
$ ml system ncdu
```
To use `ncdu`, add `ml system ncdu` to the bottom of your `~/.bash_profile`, which will load the `ncdu` module each time you log in to Sherlock.
You can add and access it with the following commands:
````bash
$ echo "ml system ncdu" >> ~/.bash_profile
$ source ~/.bash_profile

$ ml system ncdu
```

In future login session, you can access the `ncdu` command via
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In future login session, you can access the `ncdu` command via
In future login sessions, `ncdu` will be accessible without calling `source`.
Use the `ncdu` command via

@effigies
Copy link
Contributor

Made a couple small suggestions. I'm +1 for merging, and things can always be improved.

@ebridge2
Copy link
Contributor

Cool; I actually was concurrently reviewing and fixed that and added a few minor clarifications @effigies

@effigies effigies merged commit ca7462b into poldracklab:main Jun 12, 2024
2 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.

Computing: New Delineation of Computing tab
3 participants