From 348d24b479525454ead917264896cd543b082a2c Mon Sep 17 00:00:00 2001 From: "Marco A. Lopez-Sanchez" Date: Fri, 23 Feb 2024 19:54:14 +0100 Subject: [PATCH] Update getting started_src.md --- DOCS/getting started_src.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/DOCS/getting started_src.md b/DOCS/getting started_src.md index efdc727..3a2c57e 100644 --- a/DOCS/getting started_src.md +++ b/DOCS/getting started_src.md @@ -24,7 +24,7 @@ https://docs.anaconda.com/free/anaconda/install/ Once Anaconda is installed, launch the _Anaconda Navigator_ and you will see that you have installed various scientifically oriented Integrated Development Systems (IDEs), including **JupyterLab** and the **Jupyter Notebook**. Clicking on any of these will open the corresponding application in your default web browser. The GrainSizeTools documentation is written assuming that you will be working using Jupyter Notebooks. -![](https://raw.githubusercontent.com/marcoalopez/GrainSizeTools/master/FIGURES/anaconda_nav.jpg) +![](https://raw.githubusercontent.com/marcoalopez/GrainSizeTools/master/imgs/anaconda_nav.jpg) _The appearance of the Anaconda navigator. Framed in red and orange are JupyterLab (preferred option) and Jupyter Notebooks (both should be installed by default in Anaconda). JupyterLab is the next generation of the Classic Jupyter Notebook application interface, providing an easy-to-use environment focused on data science._ > [!TIP] @@ -74,13 +74,13 @@ _An example of a Jupyter Notebook with code, equations (using Latex), visualizat When you first open JupyterLab, you should see something similar to this -TODO -> image +![](https://raw.githubusercontent.com/marcoalopez/GrainSizeTools/master/imgs/JupyterLab_interface.png) with the following elements: - The **Menu Bar** at the top of the screen, which has familiar drop-down menus like: “File”, “Edit”, “View”, etc. -- The **Workspace Area** currently displaying the **Launcher**. This allows users to access the Console/Terminal or create new Notebooks, Python, Text, or Markdown files. +- The **Workspace Area** currently displaying the **Launcher**. This allows users to access the Console and Terminal or create new Notebooks, Python, Text, or Markdown files. - The **Collapsible Sidebar** on the left contains a File Browser, along with other elements such as running tabs and kernels information, notebook table of contents, and the Extensions Manager. @@ -92,15 +92,15 @@ At this point, use the launcher to create your first Jupyter notebook. When you create a notebook, you'll find an empty cell at the top. These cells can be used for writing code, text (which is called markdown), or raw content. You can see the type of cell at the top of the notebook tab and change it anytime. When you click inside a cell, it turns white with a blinking cursor, showing it's ready for editing. +![](https://raw.githubusercontent.com/marcoalopez/GrainSizeTools/master/imgs/notebook_topMenu.png) +_The JupyterLab interface...TODO. More info at_ https://jupyterlab.readthedocs.io/en/latest/user/interface.html#the-jupyterlab-interface + If it's a code cell, you can write Python code inside. When you run the cell by pressing ``Shift+Enter``, the code gets executed, and any results appear just below the cell. This action, pressing ``Shift+Enter``, will also create a new cell just below it. If it is a text cell instead, you can use [Markdown](https://www.markdownguide.org/cheat-sheet/) to write down what you think you need. When you're ready, press ``Shift+Enter``, and a new cell will be created below it. Repeat this as many times as you need. If you open an already edited notebook or template, using the collapsible sidebar or ``File > Open from Path``, the cells will already be created, and you can edit them by clicking on the cell you want to edit and executing it when you are finished. -TODO -> -_The JupyterLab interface...TODO. More info at_ https://jupyterlab.readthedocs.io/en/latest/user/interface.html#the-jupyterlab-interface - ## Step 4: Understanding the script structure and the workflow @@ -149,7 +149,6 @@ Once you have everything installed, open JupyterLab or Jupyter Notebooks and in > [!CAUTION] > In your notebook, you can run cells in any order by selecting them and pressing ``Shift+Enter``. But, when you share your notebook, it's best to run cells in the order they're shown. To do this, you can restart the kernel and then go to the menu bar and click on ``Run > Run All``. This helps prevent unexpected issues if you're using variables between cells and improve reproducibility. Just be cautious when changing the order. - #### Importing data using the Pandas library TODO \ No newline at end of file