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

Add initial documentation #1

Merged
merged 3 commits into from
Sep 13, 2024
Merged

Add initial documentation #1

merged 3 commits into from
Sep 13, 2024

Conversation

paytoncain
Copy link
Collaborator

Please take a look at the initial documentation I have prepared for PACE. This edit adds content to our README and a jupyter notebook documenting CLI usage. Also, I added an HTML version of the jupyter notebook to supplement in the case that a CLI user is not familiar with python or jupyter notebooks. Please let me know what content needs to be changed or added before merging this into the main branch.

@paytoncain paytoncain added the documentation Improvements or additions to documentation label Sep 12, 2024
Copy link
Collaborator

@QuincyCantu QuincyCantu left a comment

Choose a reason for hiding this comment

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

I think things look great, I honestly don't have any notes! Super clean and concise.

@Chuck-A
Copy link

Chuck-A commented Sep 13, 2024 via email

@paytoncain
Copy link
Collaborator Author

@QuincyCantu had a good suggestion as a final detail. In the case of a user opening the notebook in google colab (outside of the contents of their local machine), they'd probably like an installation section for the CLI. Added the following content in a cell below initial python imports:

!curl -L -O https://github.com/CI-CMG/pace/releases/download/trunk-latest/pace-cli-Linux-X64-0.1.1-SNAPSHOT.zip
!unzip pace-cli-Linux-X64-0.1.1-SNAPSHOT.zip
!chmod +x pace-cli-Linux-X64/bin/pace-cli
os.environ['PATH'] += ':./pace-cli-Linux-X64/bin'

@paytoncain paytoncain merged commit b34b381 into trunk Sep 13, 2024
10 checks passed
@paytoncain paytoncain deleted the add-readme-content branch September 13, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants