|
| 1 | +<p>The following sections explain how to operate the Research Environment with <a rel='nofollow' target='_blank' href='https://jupyterlab.readthedocs.io/en/latest/index.html'>JupyterLab</a>, the default IDE.</p> |
| 2 | + |
| 3 | +<h4>Open Notebooks</h4> |
| 4 | +<p>Follow these steps to open a research notebook in JupyterLab:</p> |
| 5 | +<ol> |
| 6 | + <li><a href='/docs/v2/lean-cli/research#02-Start-the-Research-Environment'>Start a local research environment</a> for the project that contains the notebook.</li> |
| 7 | + <li>In the left navigation menu, click the <img class='inline-icon' src='https://cdn.quantconnect.com/i/tu/jupyterlab-file-browser-icon.png' alt='JupyterLab File Browser icon'> <span class='icon-name'>File Browser</span> icon.</li> |
| 8 | + <li>In the File Browser panel, double-click the notebook file you want to open.</li> |
| 9 | + <p>The default notebook is <span class='public-file-name'>research.ipynb</span>.</p> |
| 10 | + <img class='docs-image' src='https://cdn.quantconnect.com/i/tu/jupyterlab-open-notebooks.png' alt='Open notebooks with JupyterLab'> |
| 11 | +</ol> |
| 12 | +<p>For more information about opening files in JupyterLab, see <a rel='nofollow' target='_blank' href='https://jupyterlab.readthedocs.io/en/latest/user/files.html#opening-files'>Opening Files</a> in the JupyterLab documentation.</p> |
| 13 | + |
| 14 | + |
| 15 | +<h4>Run Notebook Cells</h4> |
| 16 | +<? include(DOCS_RESOURCES."/getting-started/research-environment/run-notebook-cells.html"); ?> |
| 17 | +<p>For more information about keyboard shortcuts in JupyterLab, see <a rel='nofollow' target='_blank' href='https://jupyterlab.readthedocs.io/en/latest/user/interface.html#keyboard-shortcuts'>Keyboard Shortcuts</a> in the JupyterLab documentation.</p> |
| 18 | + |
| 19 | + |
| 20 | +<h4>Stop Nodes</h4> |
| 21 | +<p>Follow these steps to stop a research node in JupyterLab:</p> |
| 22 | +<ol> |
| 23 | + <li>In the left navigation menu, click the <img class='inline-icon' src='https://cdn.quantconnect.com/i/tu/jupyterlab-running-terminals-and-kernals-icon.png' alt='JupyterLab Running Terminals and Kernals icon'></span> <span class='icon-name'>Running Terminals and Kernels</span> icon.</li> |
| 24 | + <li>In the <span class='page-section-name'>Kernals</span> section of the Running Terminals and Kernels panel, right-click the name of the notebook file and then click <span class='button-name'>Shut Down Kernel</span> from the drop-down menu.</li> |
| 25 | +</ol> |
| 26 | +<img class='docs-image' src='https://cdn.quantconnect.com/i/tu/jupyterlab-stop-nodes.png' alt='Stop notebooks with JupyterLab'> |
| 27 | +<p>For more information about the Running Terminals and Kernels panel in JupyterLab, see <a rel='nofollow' target='_blank' href='https://jupyterlab.readthedocs.io/en/latest/user/running.html'>Managing Kernels and Terminals</a> in the JupyterLab documentation.</p> |
| 28 | + |
| 29 | +<h4>Add Notebooks</h4> |
| 30 | +<p>Follow these steps to add notebook files to a project in JupyterLab:</p> |
| 31 | +<ol> |
| 32 | + <li><a href='/docs/v2/lean-cli/research#02-Start-the-Research-Environment'>Start a local research environment</a> for the project.</li> |
| 33 | + <li>In the top navigation menu, click <span class='button-name'>File > New > Notebook</span>.</li> |
| 34 | + <li>In the Select Kernel window, click <span class='button-name'>Select</span>.</li> |
| 35 | +</ol> |
| 36 | +<p>For more information about the creating files in JupyterLab, see <a rel='nofollow' target='_blank' href='https://jupyterlab.readthedocs.io/en/latest/user/files.html#creating-files-and-activities'>Creating Files and Activities</a> in the JupyterLab documentation.</p> |
| 37 | + |
| 38 | +<h4>Rename Notebooks</h4> |
| 39 | +<p>Follow these steps to rename notebook files in JupyterLab:</p> |
| 40 | +<ol> |
| 41 | + <li><a href='/docs/v2/lean-cli/research#02-Start-the-Research-Environment'>Start a local research environment</a> for the project that contains the notebook.</li> |
| 42 | + <li>In the left navigation menu, click the <img class='inline-icon' src='https://cdn.quantconnect.com/i/tu/jupyterlab-file-browser-icon.png' alt='JupyterLab File Browser icon'> <span class='icon-name'>File Browser</span> icon.</li> |
| 43 | + <li>In the File Browser panel, right-click the notebook file you want to rename and then click <span class='button-name'>Rename</span> from the drop-down menu.</li> |
| 44 | + <li>Enter the new name.</li> |
| 45 | + <li>Press <span class='key-combinations'>Enter</span>.</li> |
| 46 | +</ol> |
| 47 | + |
| 48 | + |
| 49 | +<h4>Delete Notebooks</h4> |
| 50 | +<p>Follow these steps to delete notebook files in JupyterLab:</p> |
| 51 | +<ol> |
| 52 | + <li><a href='/docs/v2/lean-cli/research#02-Start-the-Research-Environment'>Start a local research environment</a> for the project that contains the notebook.</li> |
| 53 | + <li>In the left navigation menu, click the <img class='inline-icon' src='https://cdn.quantconnect.com/i/tu/jupyterlab-file-browser-icon.png' alt='JupyterLab File Browser icon'> <span class='icon-name'>File Browser</span> icon.</li> |
| 54 | + <li>In the File Browser panel, right-click the notebook file you want to delete and then click <span class='button-name'>Delete</span> from the drop-down menu.</li> |
| 55 | + <li>In the Delete window, click <span class='button-name'>Delete</span>.</li> |
| 56 | +</ol> |
| 57 | + |
0 commit comments