Difference between revisions of "Github Guide"
From PREX Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
* [https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf Git cheet sheet] | * [https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf Git cheet sheet] | ||
| − | == | + | == Repositories and Discussions == |
* [https://www.github.com Github.com] | * [https://www.github.com Github.com] | ||
* [https://www.github.com/JeffersonLab JeffersonLab Github organization] | * [https://www.github.com/JeffersonLab JeffersonLab Github organization] | ||
| Line 14: | Line 14: | ||
== Working with Github == | == Working with Github == | ||
| − | + | === JLab ifarm scientific computing access === | |
| − | + | * Register as a JLab user, undergrad, or grad student ([https://misportal.jlab.org/jlabAccess/ here], or register from the "online" link in [https://www.jlab.org/hr/jris/processing.html here]). | |
| − | + | ** After registration, you have to "Register New Visit" as user group "Remote Access," even though you aren't necessarily visiting, and you will need you to call the JLab [https://cc.jlab.org/helpdesk/ helpdesk] at some point. | |
| − | + | ** While filling out the Registration form you can request an account on the JLab Common User Environment (CUE). You must include Bob Michaels (rom@jlab.org) as your JLab sponsor for the account - be sure to request access to a-parity and moller12gev user groups ([https://cc.jlab.org/useraccounts here is a good starting link]). | |
| − | + | ** To get access to swif and scientific computing resources follow the instructions [https://scicomp.jlab.org/docs/network_certificate here]. | |
| − | + | ** Then to use swif see the guide [https://kk-router.physics.sunysb.edu/Radiation,+Shielding,+and+Configuration+Simulations/28 here] or readmes in relevant repositories. | |
| − | |||
| − | |||
| − | |||
| − | + | === Jefferson Lab github access === | |
| + | Send an email with the following (and if this doesn't work ask one of the senior members of the collaboration to add you themselves): | ||
Subject: Please add me to the JeffersonLab github organization | Subject: Please add me to the JeffersonLab github organization | ||
To: <helpdesk@jlab.org> | To: <helpdesk@jlab.org> | ||
| Line 32: | Line 30: | ||
My github username is ______ and account id is ______ | My github username is ______ and account id is ______ | ||
| − | * Once you have Github set up on your computer (following one of the guides above), you can begin working with Github. Github includes some features to maximize the efficiency of collaborative work, including such things as pull requests, projects, and issue tracking. | + | === Using Github === |
| − | + | * Once you have Github set up on your computer (following one of the guides above), you can begin working with Github, committing, pushing, and pulling your work and managing offshoot branches of new projects. | |
| − | * If you want to get started on some new work you should jump into an outstanding issue or project, which are available in the related tabs on the web-page version of each repository. For example, you can begin by either starting a new issue or project, or by inserting yourself into the conversation of an issue, like in the [https://github.com/JeffersonLab/japan/issues JAPAN] repository. Anyone with a github account can participate, though obtaining write-privileges requires access to the JeffersonLab organization. | + | * Github includes some features to maximize the efficiency of collaborative work, including such things as pull requests, projects, and issue tracking. |
| + | * If you want to get started on some new work you should jump into an outstanding issue or project, which are available in the related tabs on the web-page version of each repository. | ||
| + | ** For example, you can begin by either starting a new issue or project, or by inserting yourself into the conversation of an issue, like in the [https://github.com/JeffersonLab/japan/issues JAPAN] repository. | ||
| + | ** Anyone with a github account can participate, though obtaining write-privileges requires access to the JeffersonLab organization (as documented above). | ||
[[Category:Analyzer]][[Category:DAQ]] | [[Category:Analyzer]][[Category:DAQ]] | ||
Latest revision as of 22:22, 4 February 2019
Guides
- Getting started with github: Windows (desktop), Unix (command line)
- What is version control?
- Git User's Manual
- Git cheet sheet
Repositories and Discussions
- Github.com
- JeffersonLab Github organization
- JAPAN (Just another parity analyzer)
- prexSim
- Hall A Parity DAQ software
- prexcollab.slack.com is the PREX/CREX Slack organization with project specific sub-channels
Working with Github
JLab ifarm scientific computing access
- Register as a JLab user, undergrad, or grad student (here, or register from the "online" link in here).
- After registration, you have to "Register New Visit" as user group "Remote Access," even though you aren't necessarily visiting, and you will need you to call the JLab helpdesk at some point.
- While filling out the Registration form you can request an account on the JLab Common User Environment (CUE). You must include Bob Michaels (rom@jlab.org) as your JLab sponsor for the account - be sure to request access to a-parity and moller12gev user groups (here is a good starting link).
- To get access to swif and scientific computing resources follow the instructions here.
- Then to use swif see the guide here or readmes in relevant repositories.
Jefferson Lab github access
Send an email with the following (and if this doesn't work ask one of the senior members of the collaboration to add you themselves):
Subject: Please add me to the JeffersonLab github organization To: <helpdesk@jlab.org> Hello, I'm a JLab user and my JLab user name is _______. Could you please add me to the JeffersonLab github organization? My github username is ______ and account id is ______
Using Github
- Once you have Github set up on your computer (following one of the guides above), you can begin working with Github, committing, pushing, and pulling your work and managing offshoot branches of new projects.
- Github includes some features to maximize the efficiency of collaborative work, including such things as pull requests, projects, and issue tracking.
- If you want to get started on some new work you should jump into an outstanding issue or project, which are available in the related tabs on the web-page version of each repository.
- For example, you can begin by either starting a new issue or project, or by inserting yourself into the conversation of an issue, like in the JAPAN repository.
- Anyone with a github account can participate, though obtaining write-privileges requires access to the JeffersonLab organization (as documented above).
