/hpc-lessons

Lessons on using the CEES HPC resources

Primary LanguageHTMLOtherNOASSERTION

#Using the CEES HPC resources

See https://uio-cees.github.io/hpc-lessons.

Work in progress
Once we have some contents in place, we welcome pull requests.

Many thanks to Software Carpentry for the template to this lesson material:

Please see [https://github.com/swcarpentry/lesson-example][swc-lesson-example] for instructions on formatting, building, and submitting lessons, or run make in this directory for a list of helpful commands.

LICENSE

This instructional material is derived from the Software Carpentry lesson template and made available under the same license. See the LICENSE.md file in this repository.

Contributing

If you don't have commit rights, fork the repository and submit a pull request.

If you are a member of this uio-cees team on github, you can use the following workflow.

If you haven't done so already, clone the repository to your local PC:

git clone https://github.com/uio-cees/hpc-lessons.git
cd hpc-lessons

If you have already cloned the repo, pull in the latest changes from github:

git pull

Create a new branch for your work:

git checkout -b name_of_branch

Note that this also switches you to your new branch.

Now make the changes you want, and commit them. To preview the webpages, run these commands, which should finish without warnings:

make check
make preview

Now you can check the html pages by opening them in your browser. Make sure to do this before you submit the pull request!

Once you're ready to submit a pull request, push your branch up to github:

git push

Note that the first time you do this, you'll get the following message:

fatal: The current branch name_of_branch has no upstream branch.
To push the current branch and set the remote as upstream, use

    git push --set-upstream origin name_of_branch

Then perform the command git suggests.

On github, you'll see a message saying 'Your recently pushed branches' with a button to 'Compare and & pull request'. Click that button and follow the instructions for submitting the changes as a pull request.

What if you started working but forgot to make a new branch?

###Editing tips See the FAQ at https://github.com/swcarpentry/lesson-example/blob/gh-pages/FAQ.md