forked from numpy/numpy-tutorials
-
Notifications
You must be signed in to change notification settings - Fork 0
NumPy tutorials & educational content in notebook format
License
scottyhq/numpy-tutorials
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Contributing — NumPy Tutorials</title>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link href="_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link rel="stylesheet"
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=62ba249389abaaa9ffc34bf36a076bdc1d65ee18" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf">
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=f31d14ad54b65d19161ba51d4ffff3a77ae00456"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Pairing Jupyter notebooks and MyST-NB" href="content/pairing.html" />
<link rel="prev" title="Analyzing the impact of the lockdown on air quality in Delhi, India" href="content/tutorial-air-quality-analysis.html" />
<meta name="robots" content="noindex" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="None">
<!-- Google Analytics -->
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60">
<!-- Checkboxes to toggle the left sidebar -->
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar">
<label class="overlay overlay-navbar" for="__navigation">
<div class="visually-hidden">Toggle navigation sidebar</div>
</label>
<!-- Checkboxes to toggle the in-page toc -->
<input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents">
<label class="overlay overlay-pagetoc" for="__page-toc">
<div class="visually-hidden">Toggle in-page Table of Contents</div>
</label>
<!-- Headers at the top -->
<div class="announcement header-item noprint"></div>
<div class="header header-item noprint"></div>
<div class="container-fluid" id="banner"></div>
<div class="container-xl">
<div class="row">
<!-- Sidebar -->
<div class="bd-sidebar noprint" id="site-navigation">
<div class="bd-sidebar__content">
<div class="bd-sidebar__top"><div class="navbar-brand-box">
<a class="navbar-brand text-wrap" href="index.html">
<!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 -->
<img src="_static/numpylogo.svg" class="logo" alt="logo">
<h1 class="site-logo" id="site-title">NumPy Tutorials</h1>
</a>
</div><form class="bd-search d-flex align-items-center" action="search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item active">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children">
<a class="reference internal" href="features.html">
NumPy Features
</a>
<input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
<label for="toctree-checkbox-1">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-svd.html">
Linear algebra on n-dimensional arrays
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/save-load-arrays.html">
Saving and sharing your NumPy arrays
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-ma.html">
Masked Arrays
</a>
</li>
</ul>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="applications.html">
NumPy Applications
</a>
<input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
<label for="toctree-checkbox-2">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="content/mooreslaw-tutorial.html">
Determining Moore’s Law with real data in NumPy
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-deep-learning-on-mnist.html">
Deep learning on MNIST
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-deep-reinforcement-learning-with-pong-from-pixels.html">
Deep reinforcement learning with Pong from pixels
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-nlp-from-scratch.html">
Sentiment Analysis on notable speeches of the last decade
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-x-ray-image-processing.html">
X-ray image processing
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-static_equilibrium.html">
Determining Static Equilibrium in NumPy
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-plotting-fractals.html">
Plotting Fractals
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-air-quality-analysis.html">
Analyzing the impact of the lockdown on air quality in Delhi, India
</a>
</li>
</ul>
</li>
<li class="toctree-l1 current active has-children">
<a class="current reference internal" href="#">
Contributing
</a>
<input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
<label for="toctree-checkbox-3">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="content/pairing.html">
Pairing Jupyter notebooks and MyST-NB
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="content/tutorial-style-guide.html">
Learn to write a NumPy tutorial
</a>
</li>
</ul>
</li>
</ul>
</div>
</nav></div>
<div class="bd-sidebar__bottom">
<!-- To handle the deprecated key -->
<div class="navbar_extra_footer">
Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a>
</div>
</div>
</div>
<div id="rtd-footer-container"></div>
</div>
<!-- A tiny helper pixel to detect if we've scrolled -->
<div class="sbt-scroll-pixel-helper"></div>
<!-- Main content -->
<div class="col py-0 content-container">
<div class="header-article row sticky-top noprint">
<div class="col py-1 d-flex header-article-main">
<div class="header-article__left">
<label for="__navigation"
class="headerbtn"
data-toggle="tooltip"
data-placement="right"
title="Toggle navigation"
>
<span class="headerbtn__icon-container">
<i class="fas fa-bars"></i>
</span>
</label>
</div>
<div class="header-article__right">
<button onclick="toggleFullScreen()"
class="headerbtn"
data-toggle="tooltip"
data-placement="bottom"
title="Fullscreen mode"
>
<span class="headerbtn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<div class="menu-dropdown menu-dropdown-repository-buttons">
<button class="headerbtn menu-dropdown__trigger"
aria-label="Source repositories">
<i class="fab fa-github"></i>
</button>
<div class="menu-dropdown__content">
<ul>
<li>
<a href="https://github.com/numpy/numpy-tutorials/"
class="headerbtn"
data-toggle="tooltip"
data-placement="left"
title="Source repository"
>
<span class="headerbtn__icon-container">
<i class="fab fa-github"></i>
</span>
<span class="headerbtn__text-container">repository</span>
</a>
</li>
<li>
<a href="https://github.com/numpy/numpy-tutorials//issues/new?title=Issue%20on%20page%20%2Fcontributing.html&body=Your%20issue%20content%20here."
class="headerbtn"
data-toggle="tooltip"
data-placement="left"
title="Open an issue"
>
<span class="headerbtn__icon-container">
<i class="fas fa-lightbulb"></i>
</span>
<span class="headerbtn__text-container">open issue</span>
</a>
</li>
<li>
<a href="https://github.com/numpy/numpy-tutorials/edit/main/site/contributing.md"
class="headerbtn"
data-toggle="tooltip"
data-placement="left"
title="Edit this page"
>
<span class="headerbtn__icon-container">
<i class="fas fa-pencil-alt"></i>
</span>
<span class="headerbtn__text-container">suggest edit</span>
</a>
</li>
</ul>
</div>
</div>
<div class="menu-dropdown menu-dropdown-download-buttons">
<button class="headerbtn menu-dropdown__trigger"
aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<div class="menu-dropdown__content">
<ul>
<li>
<a href="_sources/contributing.md.txt"
class="headerbtn"
data-toggle="tooltip"
data-placement="left"
title="Download source file"
>
<span class="headerbtn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="headerbtn__text-container">.md</span>
</a>
</li>
<li>
<button onclick="printPdf(this)"
class="headerbtn"
data-toggle="tooltip"
data-placement="left"
title="Print to PDF"
>
<span class="headerbtn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="headerbtn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
</div>
<label for="__page-toc"
class="headerbtn headerbtn-page-toc"
>
<span class="headerbtn__icon-container">
<i class="fas fa-list"></i>
</span>
</label>
</div>
</div>
<!-- Table of contents -->
<div class="col-md-3 bd-toc show noprint">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> Contents
</div>
<nav id="bd-toc-nav" aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#why-jupyter-notebooks">
Why Jupyter Notebooks?
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#note">
Note
</a>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#adding-your-own-tutorials">
Adding your own tutorials
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#create-an-issue">
Create an issue
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#check-out-our-suggested-template">
Check out our suggested template
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#upload-your-content">
Upload your content
</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
<div class="article row">
<div class="col pl-md-3 pl-lg-5 content-container">
<!-- Table of contents that is only displayed when printing the page -->
<div id="jb-print-docs-body" class="onlyprint">
<h1>Contributing</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#why-jupyter-notebooks">
Why Jupyter Notebooks?
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#note">
Note
</a>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#adding-your-own-tutorials">
Adding your own tutorials
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#create-an-issue">
Create an issue
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#check-out-our-suggested-template">
Check out our suggested template
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#upload-your-content">
Upload your content
</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<main id="main-content" role="main">
<div>
<section id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">#</a></h1>
<p>We very much welcome contributions! If you have an idea or proposal for a new
tutorial, please <a class="reference external" href="https://github.com/numpy/numpy-tutorials/issues">open an issue</a>
with an outline.</p>
<p>Don’t worry if English is not your first language, or if you can only come up
with a rough draft. Open source is a community effort. Do your best – we’ll help
fix issues.</p>
<p>Images and real-life data make text more engaging and powerful, but be sure what
you use is appropriately licensed and available. Here again, even a rough idea
for artwork can be polished by others.</p>
<p>The NumPy tutorials are a curated collection of
<a class="reference external" href="https://myst-nb.readthedocs.io/">MyST-NB</a> notebooks. These notebooks are used
to produce static websites and can be opened as notebooks in Jupyter using
<a class="reference external" href="https://jupytext.readthedocs.io">Jupytext</a>.</p>
<blockquote>
<div><p><strong>Note:</strong> You should use <a class="reference external" href="https://commonmark.org">CommonMark</a> markdown
cells. Jupyter only renders CommonMark.</p>
</div></blockquote>
<section id="why-jupyter-notebooks">
<h2>Why Jupyter Notebooks?<a class="headerlink" href="#why-jupyter-notebooks" title="Permalink to this headline">#</a></h2>
<p>The choice of Jupyter Notebook in this repo instead of the usual format
(<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">reStructuredText</a>)
used in the main NumPy documentation has two reasons:</p>
<ul class="simple">
<li><p>Jupyter notebooks are a common format for communicating scientific
information.</p></li>
<li><p>Jupyter notebooks can be launched in <a class="reference external" href="https://www.mybinder.org">Binder</a>, so that users can interact
with tutorials</p></li>
<li><p>rST may present a barrier for some people who might otherwise be very
interested in contributing tutorial material.</p></li>
</ul>
<section id="note">
<h3>Note<a class="headerlink" href="#note" title="Permalink to this headline">#</a></h3>
<p>You may notice our content is in markdown format (<code class="docutils literal notranslate"><span class="pre">.md</span></code> files). We review and
host notebooks in the <a class="reference external" href="https://myst-nb.readthedocs.io/">MyST-NB</a> format. We
accept both Jupyter notebooks (<code class="docutils literal notranslate"><span class="pre">.ipynb</span></code>) and MyST-NB notebooks (<code class="docutils literal notranslate"><span class="pre">.md</span></code>).
If you want to sync your <code class="docutils literal notranslate"><span class="pre">.ipynb</span></code> to your <code class="docutils literal notranslate"><span class="pre">.md</span></code> file follow the <a class="reference internal" href="content/pairing.html"><span class="doc std std-doc">pairing
tutorial</span></a>.</p>
<div class="toctree-wrapper compound">
</div>
</section>
</section>
<section id="adding-your-own-tutorials">
<h2>Adding your own tutorials<a class="headerlink" href="#adding-your-own-tutorials" title="Permalink to this headline">#</a></h2>
<p>If you have your own tutorial in the form of a Jupyter notebook (an <code class="docutils literal notranslate"><span class="pre">.ipynb</span></code>
file) and you’d like to try add it out to the repository, follow the steps below.</p>
<section id="create-an-issue">
<h3>Create an issue<a class="headerlink" href="#create-an-issue" title="Permalink to this headline">#</a></h3>
<p>Go to <a class="reference external" href="https://github.com/numpy/numpy-tutorials/issues">https://github.com/numpy/numpy-tutorials/issues</a> and create a new issue
with your proposal.
Give as much detail as you can about what kind of content you would like to
write (tutorial, how-to) and what you plan to cover.
We will try to respond as quickly as possible with comments, if applicable.</p>
</section>
<section id="check-out-our-suggested-template">
<h3>Check out our suggested template<a class="headerlink" href="#check-out-our-suggested-template" title="Permalink to this headline">#</a></h3>
<p>You can use this template to make your content consistent with our existing
tutorials:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="content/tutorial-style-guide.html">Learn to write a NumPy tutorial</a></li>
</ul>
</div>
</section>
<section id="upload-your-content">
<h3>Upload your content<a class="headerlink" href="#upload-your-content" title="Permalink to this headline">#</a></h3>
<p>Remember to clear all outputs on your notebook before uploading it.</p>
<ul>
<details>
<summary>
<b>Fork this repository</b> (if you haven't before).
</summary>
<img src="_static/01-fork.gif" width=80% height=80%>
</details>
<details>
<summary>
<b>In your own fork, create a new branch for your content.</b>
</summary>
<img src="_static/02-create_new_branch.gif" width=80% height=80%>
</details>
<details>
<summary>
<b>Add your notebook to the <code>content/</code> directory.</b>
</summary>
<img src="_static/03-upload.gif" width=80% height=80%>
</details>
<p><b>Update the <code>environment.yml</code> file with the dependencies for your tutorial</b>
(only if you add new dependencies).</p>
<details>
<summary>
<b>Update this <code>README.md</code> to include your new entry.</b>
</summary>
<img src="_static/04-add_to_readme.gif" width=80% height=80%>
</details>
<details>
<summary>
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a> Make sure the "Allow edits and access to secrets by maintainers" option is selected so we can properly review your submission.</b>
</summary>
<img src="_static/05-create_PR.gif" width=80% height=80%>
</details>
<p>🎉 <b>Wait for review!</b></p>
</ul>
<p>For more information about GitHub and its workflow, you can see
<a class="reference external" href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests">this document</a>.</p>
</section>
</section>
</section>
</div>
</main>
<footer class="footer-article noprint">
<!-- Previous / next buttons -->
<div class='prev-next-area'>
<a class='left-prev' id="prev-link" href="content/tutorial-air-quality-analysis.html" title="previous page">
<i class="fas fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Analyzing the impact of the lockdown on air quality in Delhi, India</p>
</div>
</a>
<a class='right-next' id="next-link" href="content/pairing.html" title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Pairing Jupyter notebooks and MyST-NB</p>
</div>
<i class="fas fa-angle-right"></i>
</a>
</div>
</footer>
</div>
</div>
<div class="footer-content row">
<footer class="col footer"><p>
By the NumPy community<br/>
© Copyright 2020, the NumPy community.<br/>
</p>
</footer>
</div>
</div>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script>
</body>
</html>About
NumPy tutorials & educational content in notebook format
License
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published
Languages
- Python 84.5%
- Makefile 7.3%
- Batchfile 7.1%
- HTML 1.1%