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

Initial work towards demonstration code and documentation #1

Merged
merged 33 commits into from
Jul 7, 2023

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Jul 5, 2023

This PR adds changes which are intended to demonstrate how to use Python code through Anaconda on UCB RC Alpine to a CU Anschutz audience. The majority of the content surrounds explaining what Alpine "is" and how to use the code from this repository to help them learn how to use it effectively for their research purposes.

Outside the scope of this PR and as a heads up just in case it changes the review somehow: I intend to reuse some of this content for a future set-website blog article surrounding the same topic. My feeling here was that someone may stumble across this information within Github directly (in a self-contained way) or may find it more appealing to read through the set-website blog. Generally open to the approach here.

Thanks in advance for any comments and suggestions you may have! Please don't hesitate to let me know if you have any questions.

Copy link
Contributor

@vincerubinetti vincerubinetti left a comment

Choose a reason for hiding this comment

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

I can't verify the accuracy of the Slurm and Alpine info, but everything here looks good. Cleanly explained and laid out. If I were needing to make use of Alpine, I think I could do it without problems following the instructions here.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
run_script.sh Outdated Show resolved Hide resolved
run_script.sh Outdated Show resolved Hide resolved
run_script.sh Outdated Show resolved Hide resolved
run_script.sh Outdated Show resolved Hide resolved
code/example.py Outdated Show resolved Hide resolved
d33bs and others added 5 commits July 6, 2023 12:18
Co-Authored-By: Vincent Rubinetti <[email protected]>
Co-Authored-By: Vincent Rubinetti <[email protected]>
d33bs and others added 3 commits July 6, 2023 12:34
Co-Authored-By: Vincent Rubinetti <[email protected]>
Co-Authored-By: Vincent Rubinetti <[email protected]>
Co-Authored-By: Vincent Rubinetti <[email protected]>
Copy link
Contributor

@falquaddoomi falquaddoomi left a comment

Choose a reason for hiding this comment

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

Great work! I have no issues with the content itself; I think it's all good and quite valuable. I'm going to go ahead and approve it since we're on a bit of a tight deadline, but feel free to look at my comments and integrate them as you like.

That said, I don't know enough about the target audience quite yet to know what will make sense to them, what will go over their heads, and what they'll want to do that might be missing. IMHO, I think we should trial it with some people and keep this as a living document that we simplify or expand according to our test readers' feedback.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@d33bs
Copy link
Member Author

d33bs commented Jul 7, 2023

Thanks @vincerubinetti and @falquaddoomi for the great reviews and content suggestions! I think I've addressed all comments and will be merging this in.

@d33bs d33bs merged commit 0ea8fad into CU-DBMI:main Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants