{"id":30063704,"url":"https://github.com/thejacksonlaboratory/intro-to-hpc","last_synced_at":"2026-02-11T01:07:39.128Z","repository":{"id":91648914,"uuid":"488720950","full_name":"TheJacksonLaboratory/intro-to-hpc","owner":"TheJacksonLaboratory","description":"An introduction to HPC","archived":false,"fork":false,"pushed_at":"2023-06-01T15:45:24.000Z","size":2377,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"gh-pages","last_synced_at":"2026-01-30T07:33:53.806Z","etag":null,"topics":["globus","hpc","hpc-applications","hpc-clusters","hpc-systems","ssh"],"latest_commit_sha":null,"homepage":"https://thejacksonlaboratory.github.io/intro-to-hpc/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheJacksonLaboratory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-04T19:36:33.000Z","updated_at":"2022-12-07T20:46:44.000Z","dependencies_parsed_at":"2024-04-22T17:03:08.303Z","dependency_job_id":null,"html_url":"https://github.com/TheJacksonLaboratory/intro-to-hpc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"carpentries/workshop-template","purl":"pkg:github/TheJacksonLaboratory/intro-to-hpc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJacksonLaboratory%2Fintro-to-hpc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJacksonLaboratory%2Fintro-to-hpc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJacksonLaboratory%2Fintro-to-hpc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJacksonLaboratory%2Fintro-to-hpc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheJacksonLaboratory","download_url":"https://codeload.github.com/TheJacksonLaboratory/intro-to-hpc/tar.gz/refs/heads/gh-pages","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJacksonLaboratory%2Fintro-to-hpc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29323979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T00:34:26.354Z","status":"ssl_error","status_checked_at":"2026-02-11T00:34:09.494Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["globus","hpc","hpc-applications","hpc-clusters","hpc-systems","ssh"],"created_at":"2025-08-08T04:47:44.539Z","updated_at":"2026-02-11T01:07:39.118Z","avatar_url":"https://github.com/TheJacksonLaboratory.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Website](https://github.com/carpentries/workshop-template/actions/workflows/website.yml/badge.svg)](https://github.com/carpentries/workshop-template/actions/workflows/website.yml)\n\n# The Carpentries Workshop Template\n\nThis repository is The Carpentries' ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and\n[Library Carpentry][lc-site]'s) template for creating websites for workshops.\n\n1. **Please _do not fork this repository directly on GitHub._** Instead, please use GitHub's\n   \"template\" function following [the instructions below](#creating-a-repository) to copy this\n   `workshop-template` repository and customize it for your workshop.\n\n2. Please *do your work in your repository's `gh-pages` branch*, since that is what is\n   [automatically published as a website by GitHub][github-project-pages].\n\n3. Once you are done, please also [let us know][email] the workshop URL. If this is a self-organised\n   workshop, you should also [fill in the self-organized workshop\n   form][self-organized-workshop-form] (if you have not already done so), so we can keep track of\n   all workshops. We build the list of workshops on our websites from the data included in your\n   `index.md` page. We can only do that if you [customize][customization] that page correctly *and*\n   let us know the workshop URL.\n\nIf you run into problems,\nor have ideas about how to make this process simpler,\nplease [get in touch](#getting-and-giving-help).\nThe pages on [customizing your website][customization],\nthe [FAQ][faq],\nand the [design notes][design] have more detail on what we do and why.\nAnd please note:\nif you are teaching Git,\nplease [create a separate repository](#setting-up-a-separate-repository-for-learners)\nfor your learners to practice in.\n\n## Video Tutorial\n\nThere is a [YouTube video](https://www.youtube.com/watch?v=_Ag1JiZzyUQ) that demonstrates how to\ncreate a workshop website.\n\n## Creating a Repository\n\n1.  Log in to GitHub.\n    (If you do not have an account, you can quickly create one for free.)\n    You must be logged in for the remaining steps to work.\n\n2.  On this page (\u003chttps://github.com/carpentries/workshop-template\u003e),\n    click on the green \"Use this template\" button (top right)\n\n    ![screenshot of this repository's GitHub page with an arrow pointing to the the 'use this template' button on the top left](fig/select-github-use-template.png?raw=true)\n\n3.  Select the owner for your new repository.\n    (This will probably be you, but may instead be an organization you belong to.)\n\n4.  Choose a name for your workshop website repository.\n    This name should have the form `YYYY-MM-DD-site`,\n    e.g., `2016-12-01-oomza`,\n    where `YYYY-MM-DD` is the start date of the workshop.\n    If your workshop is held online, then the respository name should have `-online` in the end.\n    e.g., `2016-12-01-oomza-online`\n\n5.  Make sure the repository is public, leave \"Include all branches\" unchecked, and click\non \"Create repository from template\".\nYou will be redirected to your new copy of the workshop template respository.\n\n6. Your new website will be rendered at `https://your_username.github.io/YYYY-MM-DD-site`.\nFor example, if your username is `gvwilson`, the website's URL will be\n`https://gvwilson.github.io/2016-12-01-oomza`.\n\nIf you experience a problem, please [get in touch](#getting-and-giving-help).\n\n## Customizing Your Website (Required Steps)\n\nThere are two ways of customizing your website. You can either:\n\n- edit the files directly in GitHub using your web browser\n- clone the repository on your computer and update the files locally\n\n### Updating the files on GitHub in your web browser\n\n1.  Go into your newly-created repository,\n    which will be at `https://github.com/your_username/YYYY-MM-DD-site`.\n    For example,\n    if your username is `gvwilson`,\n    the repository's URL will be `https://github.com/gvwilson/2016-12-01-oomza`.\n\n3.  Ensure you are on the gh-pages branch by clicking on the branch under the drop\n    down in the menu bar (see the note below):\n\n    ![screenshot of this repository's GitHub page showing the \"Branch\" dropdown menu expanded with the \"gh-pages\" branch selected](fig/select-gh-pages-branch.png?raw=true)\n\n3.  Edit the header of `index.md` to customize the list of instructors,\n    workshop venue, etc.\n    You can do this in the browser by clicking on it in the file view on GitHub\n    and then selecting the pencil icon in the menu bar:\n\n    ![screenshot of top menu bar for GitHub's file interface with the edit icon highlighted in the top right](fig/edit-index-file-menu-bar.png?raw=true)\n\n    Editing hints are embedded in `index.md`,\n    and full instructions are in [the customization instructions][customization].\n\n4.  Remove the notice about using the workshop template in the `index.md` file. You can safely\n    delete everything between the `{% comment %}` and `{% endcomment %}` (included) as indicated\n    below (about from line 35 to line 51):\n\n    ```jekyll\n    {% comment %} \u003c------------ remove from this line\n    8\u003c ============= For a workshop delete from here =============\n    For a workshop please delete the following block until the next dashed-line\n    {% endcomment %}\n\n    \u003cdiv class=\"alert alert-danger\"\u003e\n      ....\n    \u003c/div\u003e\n\n    {% comment %}\n     8\u003c ============================= until here ==================\n    {% endcomment %} \u003c--------- until this line\n    ```\n\n4.  Edit `_config.yml` to customize certain site-wide variables, such as: `carpentry` (to tell your\n    participants the lesson program for your workshop), `curriculum` and `flavor` for the\n    curriculum  taught in your workshop, and `title` (overall title for all pages).\n\n    Editing hints are embedded in `_config.yml`,\n    and full instructions are in [the customization instructions][customization].\n\n5. Edit the `schedule.html` file to edit the schedule for your upcoming workshop. This file is\n   located in the `_includes` directory, make sure to choose the one from the appropriate `dc` (Data\n   Carpentry workshop), `lc` (Library Carpentry), or `swc` (Software Carpentry) subdirectory.\n\n### Working locally\n\n\u003e Note: you don't have to do this, if you have already updated your site using the web interface.\n\n\nIf you are already familiar with Git, you can clone the repository to your desktop, edit `index.md`,\n`_config.yml`, and `schedule.html` following the instruction above there, and push your changes back to the repository.\n\n```shell\ngit clone https://github.com/your_username/YYYY-MM-DD-site\n```\n\nIn order to view your changes once you are done editing, if you have bundler installed (see the\n[installation instructions below](#installing-software)), you can preview your site locally with:\n\n```shell\nmake serve\n```\nand go to \u003chttp://0.0.0.0:4000\u003e to preview your site.\n\nBefore pushing your changes to your repository, we recommend that you also check for any potential\nissues with your site by running:\n\n```shell\nmake workshop-check\n```\n\nOnce you are satisfied with the edits to your site, commit and push the changes to your repository.\nA few minutes later, you can go to the GitHub Pages URL for your workshop site and preview it. In the example above, this is `https://gvwilson.github.io/2016-12-01-oomza`. [The finished\npage should look something like this](fig/completed-page.png?raw=true).\n\n\n## Optional but Recommended Steps\n\n\n### Update your repository description and link your website\n\nAt the top of your repository on GitHub you'll see\n\n~~~\nNo description, website, or topics provided. — Edit\n~~~\n\nClick 'Edit' and add:\n\n1.  A very brief description of your workshop in the \"Description\" box (e.g., \"Oomza University workshop, Dec. 2016\")\n\n2.  The URL for your workshop in the \"Website\" box (e.g., `https://gvwilson.github.io/2016-12-01-oomza`)\n\nThis will help people find your website if they come to your repository's home page.\n\n### Update the content of the README file\n\nYou can change the `README.md` file in your website's repository, which contains these instructions,\nso that it contains a short description of your workshop and a link to the workshop website.\n\n\n## Additional Notes\n\n**Note:**\nplease do all of your work in your repository's `gh-pages` branch,\nsince [GitHub automatically publishes that as a website][github-project-pages].\n\n**Note:**\nthis template includes some files and directories that most workshops do not need,\nbut which provide a standard place to put extra content if desired.\nSee the [design notes][design] for more information about these.\n\nFurther instructions are available in [the customization instructions][customization].\nThis [FAQ][faq] includes a few extra tips (additions are always welcome)\nand these notes on [the background and design][design] of this template may help as well.\n\n\n## Creating Extra Pages\n\nIn rare cases,\nyou may want to add extra pages to your workshop website.\nYou can do this by putting either Markdown or HTML pages in the website's root directory\nand styling them according to the instructions give in\n[the lesson template][lesson-example].\n\n\n## Installing Software\n\nIf you want to set up Jekyll so that you can preview changes on your own machine before pushing them\nto GitHub, you must install the software described in the lesson example [setup\ninstructions](https://carpentries.github.io/lesson-example/setup.html#jekyll-setup-for-lesson-development).\n\n## Setting Up a Separate Repository for Learners\n\nIf you are teaching Git,\nyou should create a separate repository for learners to use in that lesson.\nYou should not have them use the workshop website repository because:\n\n* your workshop website repository contains many files that most learners don't need to see during\n  the lesson, and\n\n* you probably don't want to accidentally merge a damaging pull request from a novice Git user into\n  your workshop's website while you are using it to teach.\n\nYou can call this repository whatever you like, and add whatever content you need to it.\n\n## Getting and Giving Help\n\nWe are committed to offering a pleasant setup experience for our learners and organizers.\nIf you find bugs in our instructions,\nor would like to suggest improvements,\nplease [file an issue][issues]\nor [mail us][email].\n\n[email]: mailto:team@carpentries.org\n[customization]: https://carpentries.github.io/workshop-template/customization/index.html\n[dc-site]: https://datacarpentry.org\n[design]: https://carpentries.github.io/workshop-template/design/index.html\n[faq]: https://carpentries.github.io/workshop-template/faq/index.html\n[github-project-pages]: https://help.github.com/en/github/working-with-github-pages/creating-a-github-pages-site\n[issues]: https://github.com/carpentries/workshop-template/issues\n[lesson-example]: https://carpentries.github.io/lesson-example/\n[self-organized-workshop-form]: https://amy.carpentries.org/forms/self-organised/\n[swc-site]: https://software-carpentry.org\n[lc-site]: https://librarycarpentry.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthejacksonlaboratory%2Fintro-to-hpc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthejacksonlaboratory%2Fintro-to-hpc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthejacksonlaboratory%2Fintro-to-hpc/lists"}