Browse Source

bootcamp template v2

Mozhgan K. Chimeh 2 years ago
parent
commit
88989394d8

+ 3 - 2
misc/jupyter_lab_template/appName/Dockerfile

@@ -1,11 +1,12 @@
+# Copyright (c) 2021 NVIDIA Corporation.  All rights reserved.
 
 # To run this dockerfile you need to present port 8888 and provide a hostname. 
 # For instance:
 #   $ nvidia-docker run --rm -it -p "8888:8888" -e HOSTNAME=foo.example.com openacc-labs:latest
-FROM nvcr.io/hpc/pgi-compilers:ce
+FROM nvcr.io/nvidia/nvhpc:21.3-devel-cuda_multi-ubuntu20.04
 
 RUN apt update && \
     apt install -y --no-install-recommends python3-pip 
 
-ADD appName/ /labs
+ADD appName_labs/ /labs
 WORKDIR /labs

+ 38 - 0
misc/Bootcamp_template/appName/README.md

@@ -0,0 +1,38 @@
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/gpuhackathons-org/gpubootcamp?include_prereleases)](https://github.com/gpuhackathons-org/gpubootcamp/releases/latest) [![GitHub issues](https://img.shields.io/github/issues/gpuhackathons-org/gpubootcamp)](https://github.com/gpuhackathons-org/gpubootcamp/issues)
+
+
+# AppName Bootcamp
+Explain the content.
+
+If you encounter issues while using the Bootcamp materials, please provide bug reports, feedback or ask questions via [GitHub Issues](https://github.com/gpuhackathons-org/gpubootcamp/issues).
+
+## Prerequisites:
+
+Include what is needed to run this lab on its own. Include the versions of the NVIDIA Driver this was tested on, versions of profiling tools and anything else that is needed. See example below:
+
+To run this tutorial you will need a machine with NVIDIA GPU.
+
+- Install the [Docker](https://docs.docker.com/get-docker/) or [Singularity](https://sylabs.io/docs/]).
+- Install Nvidia toolkit, [Nsight Systems (latest version)](https://developer.nvidia.com/nsight-systems) and [compute (latest version)](https://developer.nvidia.com/nsight-compute).
+
+## Creating containers
+Instructions on how to create docker and singularity container. Share the steps under its sections.
+
+### Docker 
+Steps on how to build the docker container and run it.
+
+### Singularity 
+Steps on how to build the singularity container and run it.
+
+## Contributing
+
+Feel free to submit Pull Requests, create Issues or open Discussions.
+
+See [CONTRIBUTING.md](https://github.com/gpuhackathons-org/gpubootcamp/blob/master/CONTRIBUTING.md) for more detailed information on how to contribute to the Bootcamp materials.
+
+## Authors and Acknowledgment
+
+See [Contributors](https://github.com/gpuhackathons-org/gpubootcamp/graphs/contributors) for a list of contributors towards this Bootcamp.
+
+## Known issues
+If there are known issues, please list them below and link them to the issue number.

+ 19 - 0
misc/Bootcamp_template/appName/Singularity

@@ -0,0 +1,19 @@
+# Copyright (c) 2021 NVIDIA Corporation.  All rights reserved.
+
+Bootstrap: docker
+FROM: nvcr.io/nvidia/nvhpc:21.3-devel-cuda_multi-ubuntu20.04
+
+%environment
+    export XDG_RUNTIME_DIR=
+
+%post
+
+
+%files
+    appName_labs /labs
+
+%runscript
+    "$@"
+
+%labels
+    AUTHOR 

+ 1 - 0
misc/Bootcamp_template/appName/appName_labs/English/C/LICENSE

@@ -0,0 +1 @@
+License by defualt is Apache 2.0 unless stated otherwise.

misc/jupyter_lab_template/appName/English/C/jupyter_notebook/images/Nsight Diagram.png → misc/Bootcamp_template/appName/appName_labs/English/C/jupyter_notebook/images/Nsight Diagram.png


File diff suppressed because it is too large
+ 84 - 31
misc/jupyter_lab_template/appName/English/C/jupyter_notebook/appName_c_lab1.ipynb


+ 48 - 0
misc/Bootcamp_template/appName/appName_labs/English/C/jupyter_notebook/references.ipynb

@@ -0,0 +1,48 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## References\n",
+    "\n",
+    "#### ref1: https://github.com/gpuhackathons-org\n",
+    "\n",
+    "#### ref2: https://github.com/gpuhackathons-org\n",
+    "\n",
+    "-----\n",
+    "\n",
+    "# <div style=\"text-align: center ;border:3px; border-style:solid; border-color:#FF0000  ; padding: 1em\">[HOME](../../appName_start.ipynb)</div>\n",
+    "\n",
+    "-----\n",
+    "\n",
+    "--- \n",
+    "\n",
+    "## Licensing \n",
+    "\n",
+    "This material is released by OpenACC-Standard.org, in collaboration with NVIDIA Corporation, under the Creative Commons Attribution 4.0 International (CC BY 4.0). "
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.4"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

+ 4 - 0
misc/Bootcamp_template/appName/appName_labs/English/C/source_code/lab1/Makefile

@@ -0,0 +1,4 @@
+# Copyright (c) 2021 NVIDIA Corporation.  All rights reserved. 
+
+hello:
+    echo "hello world"

+ 4 - 0
misc/Bootcamp_template/appName/appName_labs/English/C/source_code/lab1/SOLUTION/Makefile

@@ -0,0 +1,4 @@
+# Copyright (c) 2021 NVIDIA Corporation.  All rights reserved. 
+
+hello:
+    echo "hello world"

+ 13 - 0
misc/Bootcamp_template/appName/appName_labs/English/C/source_code/lab1/SOLUTION/hello_world.cpp

@@ -0,0 +1,13 @@
+//////////////////////////////////////////////////////////////////////////////////////////
+// if the code is for another author, give credit as below. Otherwise only add the Copyright piece
+// Author: xx and yy  , organization
+//////////////////////////////////////////////////////////////////////////////////////////
+
+// Copyright (c) 2021 NVIDIA Corporation.  All rights reserved.
+
+#include <stdio.h>
+int main() {
+   // printf() displays the string inside quotation
+   printf("Hello, World!");
+   return 0;
+}

+ 13 - 0
misc/Bootcamp_template/appName/appName_labs/English/C/source_code/lab1/hello_world.cpp

@@ -0,0 +1,13 @@
+//////////////////////////////////////////////////////////////////////////////////////////
+// if the code is for another author, give credit as below. Otherwise only add the Copyright piece
+// Author: xx and yy  , organization
+//////////////////////////////////////////////////////////////////////////////////////////
+
+// Copyright (c) 2021 NVIDIA Corporation.  All rights reserved.
+
+#include <stdio.h>
+int main() {
+   // printf() displays the string inside quotation
+   printf("Hello, World!");
+   return 0;
+}

+ 5 - 0
misc/Bootcamp_template/appName/appName_labs/English/Presentations/README.md

@@ -0,0 +1,5 @@
+For Partners who are interested in delivering the critical hands-on skills needed to advance science in form of Bootcamp can reach out to us at [GPU Hackathon Partner](https://gpuhackathons.org/partners) website. In addition to current bootcamp material the Partners will be provided with the following:
+
+- Presentation: All the Bootcamps are accompanied with training material presentations which can be used during the Bootcamp session.
+- Mini challenge : To test the knowledge gained during this Bootcamp a mini application challenge is provided along with sample Solution.
+- Additional Support: On case to case basis the Partners can also be trained on how to effectively deliver the Bootcamp with maximal impact.

+ 9 - 9
misc/jupyter_lab_template/appName/English/appName_start.ipynb

@@ -4,25 +4,25 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## AppName Tutorial\n",
+    "## AppName Bootcamp\n",
     "\n",
     "### Learning objectives\n",
     "What are the learning objectives? What do you want to teach the attendees? Will they apply the knowledge to an application? What is so significant about this application? How would this session benefit them? \n",
     "\n",
-    "Use keywords to show what this tutorial is about without the need to start it. It should give the attendee an idea of what they will learn and how would this benefit them.\n",
+    "Use keywords to show what this Bootcamp is about without the need to start it. It should give the attendee an idea of what they will learn and how would this benefit them.\n",
     "\n",
-    "Is there an optional exercise at the end? Who is the audience? \n",
+    "Is there an optional exercise at the end? Who is the target audience? \n",
     "\n",
     "- Learn ... {fill it with more detail)\n",
     "- Learn ... \n",
     "\n",
     "What will the attendees achieve at the end?\n",
     "\n",
-    "### Tutorial Outline\n",
+    "### Bootcamp Outline\n",
     "In this section, breakdown each lab and provide detail of what to expect to learn in each lab.\n",
     "Note: Avoid adding too much information to one jupyter lab. Best practice here is to have one lab/learning objective in one notebook\n",
     "\n",
-    "- Introduction ([C](C/jupyter_notebook/appName_c_lab1.ipynb) , [xx](Fortran/jupyter_notebook/appName_fortran_lab1.ipynb))\n",
+    "- Introduction ([C](C/jupyter_notebook/lab1/appName_c_lab1.ipynb) , [xx](C/jupyter_notebook/lab1/appName_c_lab1.ipynb))\n",
     "    - Overview of ...\n",
     "    - How to use ...\n",
     "- Lab 1 (OPTIONAL: links to notebooks or any necessary part)\n",
@@ -30,7 +30,7 @@
     "    - ...\n",
     "    \n",
     "\n",
-    "### Tutorial Duration\n",
+    "### Bootcamp Duration\n",
     "The lab material will be presented in a xxx session. Link to material is available for download at the end of the lab.\n",
     "\n",
     "### Content Level\n",
@@ -43,13 +43,13 @@
     "\n",
     "\n",
     "### Start Here\n",
-    "You can choose between a [C-based code](C/jupyter_notebook/appName_c_lab1.ipynb) and a [xx-based code](Fortran/jupyter_notebook/appName_fortran_lab1.ipynb).\n",
+    "You can choose between a [C-based code](C/jupyter_notebook/lab1/appName_c_lab1.ipynb) and a [xx-based code](C/jupyter_notebook/lab1/appName_c_lab1.ipynb).\n",
     "\n",
     "--- \n",
     "\n",
     "## Licensing \n",
     "\n",
-    "This material is released by NVIDIA Corporation under the Creative Commons Attribution 4.0 International (CC BY 4.0). \n"
+    "This material is released by OpenACC-Standard.org, in collaboration with NVIDIA Corporation, under the Creative Commons Attribution 4.0 International (CC BY 4.0). \n"
    ]
   }
  ],
@@ -74,5 +74,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 1
+ "nbformat_minor": 4
 }

+ 38 - 0
misc/Bootcamp_template/appName/appName_labs/README.md

@@ -0,0 +1,38 @@
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/gpuhackathons-org/gpubootcamp?include_prereleases)](https://github.com/gpuhackathons-org/gpubootcamp/releases/latest) [![GitHub issues](https://img.shields.io/github/issues/gpuhackathons-org/gpubootcamp)](https://github.com/gpuhackathons-org/gpubootcamp/issues)
+
+
+# AppName Bootcamp
+Explain the content.
+
+If you encounter issues while using the Bootcamp materials, please provide bug reports, feedback or ask questions via [GitHub Issues](https://github.com/gpuhackathons-org/gpubootcamp/issues).
+
+## Prerequisites:
+
+Include what is needed to run this lab on its own. Include the versions of the NVIDIA Driver this was tested on, versions of profiling tools and anything else that is needed. See example below:
+
+To run this tutorial you will need a machine with NVIDIA GPU.
+
+- Install the [Docker](https://docs.docker.com/get-docker/) or [Singularity](https://sylabs.io/docs/]).
+- Install Nvidia toolkit, [Nsight Systems (latest version)](https://developer.nvidia.com/nsight-systems) and [compute (latest version)](https://developer.nvidia.com/nsight-compute).
+
+## Creating containers
+Instructions on how to create docker and singularity container. Share the steps under its sections.
+
+### Docker 
+Steps on how to build the docker container and run it.
+
+### Singularity 
+Steps on how to build the singularity container and run it.
+
+## Contributing
+
+Feel free to submit Pull Requests, create Issues or open Discussions.
+
+See [CONTRIBUTING.md](https://github.com/gpuhackathons-org/gpubootcamp/blob/master/CONTRIBUTING.md) for more detailed information on how to contribute to the Bootcamp materials.
+
+## Authors and Acknowledgment
+
+See [Contributors](https://github.com/gpuhackathons-org/gpubootcamp/graphs/contributors) for a list of contributors towards this Bootcamp.
+
+## Known issues
+If there are known issues, please list them below and link them to the issue number.

File diff suppressed because it is too large
+ 0 - 131
misc/jupyter_lab_template/appName/English/Fortran/jupyter_notebook/appName_fortran_lab1.ipynb


BIN
misc/jupyter_lab_template/appName/English/Fortran/jupyter_notebook/images/Nsight Diagram.png


+ 0 - 10
misc/jupyter_lab_template/appName/README.md

@@ -1,10 +0,0 @@
-# AppName Tutorial
-
-
-## Prerequisites:
-
-## Creating containers
-
-
-## Questions?
-Please join [OpenACC Slack Channel](https://openacclang.slack.com/messages/openaccusergroup) for questions.

+ 0 - 17
misc/jupyter_lab_template/appName/Singularity

@@ -1,17 +0,0 @@
-Bootstrap: docker
-FROM: nvcr.io/hpc/pgi-compilers:ce
-
-%environment
-    export XDG_RUNTIME_DIR=
-
-%post
-
-
-%files
-    appName /labs
-
-%runscript
-    "$@"
-
-%labels
-    AUTHOR