NCAI_Training_Notebook_R_template_for_Jupyter.ipynb 4.95 KB
Newer Older
{"cells":[{"metadata":{},"cell_type":"markdown","source":"### NCAI Training Notebook Template note to content creator\nThe purpose of the NCAI Training Notebook Template is to make sure that material has a uniform \nappearance and that contain similarly structured material. The main sections are:  \n\n* __Overview__ of the broad topic covered  \n     + __Prerequisites__ for what background information is needed to go through the notebook  \n     + __Learning outcomes__ from completing the notebook  \n* The __Tutorial__ with a balance of explanation and activity  \n* __Exercises__ for students to try that do not have solutions but maybe have an answer or \nbenchmark to facilitate understanding\n* __Next steps__ or potential follow on material\n* __Examples in NOAA__\n* __Data statement__\n* __References__\n \nAs you fill out your notebook, make sure to delete the suggestion text."},{"metadata":{},"cell_type":"markdown","source":"# Notebook Title\n\n * Creator(s)\n * Affiliation\n * History\n\n---\n\n## 1. Overview\nIn this section, include an overview of what this notebook will cover. Consider this an elevator\nspeech for the notebook.\n\n### 1.1 Prerequisites\nWhat information is needed to be successful in the notebook and provide links to other NCAI \nmaterial or external links. (We should maybe have a pool of resources that can be used here so \nthat developers do not need to do an extensive search)\n\n### 1.2 Learning Outcomes\n* What should someone learn from this notebook?\n* What might someone be able to do once done?"},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 2. Tutorial Material\nContent or sections to incorperate here\n\n  1. Provide background\n    * to the science problem, and\n    * to the ML problem\n  2. Basic examples with toy data\n  3. More complicated example ideally with NOAA data\n\n### Data section, optional\nScripts for pulling the data into the notebook assuming"},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 3. Exercises\n\nThese should be extensions from the examples used above. The answers should be straightfoward to \nget to. If a question includes additional outside material, make sure to link to a resource."},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 4. Next steps\n\nNow that the student has learned the material, what is the next notebook either in for a series or\nrelated material."},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 5. Examples in NOAA\n\nWhat are some real world / NOAA examples of how this information was used?  "},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 6. Data statement\n\nLink to the dataset(s) used in the example and/or additional information about the dataset. All \ndata used in these examples should be in the public domain and easily accessable."},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 7. References\n\nIf material in the notebook was adapted from other source material for NOAA, link to it.\n\nAlso, add other material either cited in the text or that extends content in the notebook."},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 8. Metadata\n * Language / package(s)\n * Domain\n * Application keywords\n * Geophysical keywords\n * AI keywords"},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 9. License\n\n### 9.1 Non-federal creators\n\n#### Software license\nSelect one of the following open-source, permissive lisences:  \n * GPL  \n * MIT  \n * BSD  \n\n#### Content/description license\nPlease select one of the following Creative Commons attribution licenses     \n * CC BY 4.0\n\n### 9.2 Federal creators\nThe statement in the \"Disclaimer\" section should suffice."},{"metadata":{},"cell_type":"markdown","source":"---\n\n## 10. Disclaimer\n\nThis R Notebook is a scientific product and is not official communication of the \nNational Oceanic and Atmospheric Administration, or the United States Department of Commerce. \nAll NOAA Google CoLab Jupyter notebooks are provided on an 'as is' basis and the user assumes \nresponsibility for its use. Any claims against the Department of Commerce or Department of \nCommerce bureaus stemming from the use of this Google CoLab Jupyter notebook will be governed \nby all applicable Federal law. Any reference to specific commercial products, processes, or \nservices by service mark, trademark, manufacturer, or otherwise does not constitute or imply \ntheir endorsement, recommendation or favoring by the Department of Commerce. The Department of\nCommerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner \nto imply endorsement of any commercial product or activity by DOC or the United States Government.\n"},{"metadata":{"trusted":true},"cell_type":"code","source":"","execution_count":null,"outputs":[]}],"metadata":{"kernelspec":{"name":"ir","display_name":"R","language":"R"},"language_info":{"name":"R","codemirror_mode":"r","pygments_lexer":"r","mimetype":"text/x-r-source","file_extension":".r","version":"3.6.3"}},"nbformat":4,"nbformat_minor":4}