Skip to content

Commit

Permalink
Update page order
Browse files Browse the repository at this point in the history
  • Loading branch information
CameronBodine committed Jan 8, 2025
1 parent 5ef99d0 commit 0535b81
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 11 deletions.
11 changes: 10 additions & 1 deletion docs/gettingstarted/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@ nav_exclude: false

---

# Installation Instructions
# Install PINGMapper
{: .no_toc }

Get `PINGMapper` up and running on your computer.

[![PyPI - Version](https://img.shields.io/pypi/v/pingmapper?style=flat-square&label=Latest%20Version%20(PyPi))](https://pypi.org/project/pingmapper/)

{: .fs-6 .fw-300 }

---

{: .g2k }
> As of v4.0, the PINGMapper installation process has been dramatically improved and simplified compared to the [old version](./Installation-v1.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/gettingstarted/PINGWizard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: Update Installation
title: Launch PING Wizard
nav_order: 2
parent: Getting Started

Expand All @@ -24,7 +24,7 @@ Light-weight interface for running [PING Ecosystem](../PINGEcosystem.md) utiliti
{: .g2k }
> As of v4.0, [PINGWizard](https://github.com/CameronBodine/PINGWizard) is the recommended interface for running `PINGMapper` and other utilities in the [PING Ecosystem](../PINGEcosystem.md).
`PINGWizard` is a light-weight interface for launching `PINGMapper` utilities, including running the [tests](Testing.md), processing a [sonar log](./Running.-#)
`PINGWizard` is a light-weight interface for launching `PINGMapper` utilities, including running the [tests](Testing.md), processing a [sonar log](./Running.md#process-single-sonar-log), batch process [multiple sonar logs](./Running.md#batch-process-multiple-sonar-recordings), and



Expand All @@ -37,7 +37,7 @@ Light-weight interface for running [PING Ecosystem](../PINGEcosystem.md) utiliti

There are two options for launching PINGWizard: a) [with a shortcut](#option-a---shortcut) or b) [command prompt](#option-b---conda-command-prompt).

### Option a - Shortcut
### Option A - Shortcut

During installation, you were prompted to select a location to save a batch (Windows) or bash (Linux/Mac OS) shortcut file. This file contains the commands to activate the `ping` conda environment and run PINGWizard.

Expand All @@ -53,7 +53,7 @@ On Linux/Mac OS, open a command prompt, change directory to where you saved the

<img src="../../assets/running/PINGWizard_sh.PNG"/>

#### Option b - Conda Command Prompt
#### Option B - Conda Command Prompt

Open the Conda Command Prompt used during [installation](./Installation.md). Activate the `ping` environment and launching PINGWizard by entering the following and pressing `Enter`:

Expand Down
6 changes: 4 additions & 2 deletions docs/gettingstarted/Running.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
---
layout: default
title: Running PINGMapper
title: Use PINGMapper
nav_order: 5
parent: Getting Started

nav_exclude: false

---

# Running `PINGMapper`
# Use `PINGMapper`

{: .no_toc }

Find out how to process your own sonar recordings.
{: .fs-6 .fw-300 }

---

After [installing](./Installation.md) PINGMapper, you are now ready to run a test to make sure PINGMapper is running as expected. As of v4.0, PINGMapper is run through a utility called [PINGWizard](https://github.com/CameronBodine/PINGWizard). PINGWizard is the entry-point for all current and future PING-related utilities.

There are two options for processing sonar logs: 1) process a [single sonar log](#process-single-sonar-log) or 2) process a [batch of sonar logs](#batch-process-multiple-sonar-recordings) in a directory. Continue reading to find out how.
Expand Down
14 changes: 11 additions & 3 deletions docs/gettingstarted/Testing.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
---
layout: default
title: Testing PINGMapper
title: Test PINGMapper
nav_order: 4
parent: Getting Started

nav_exclude: false

---
# Testing PINGMapper

Once you have [installed](./Installation.md) `PING-Mapper` on your computer, you can test the installation by processing two example datasets. The first is a [small](#small-dataset-test) dataset that is already downloaded into the `PING-Mapper` directory following installation. This is the fastest way to see if the software is performing as expected. A second test can be carried out on a [large](#large-dataset-test) which is automatically downloaded once you run the test. The large dataset is included to see how the software performs on a typical sonar recording.
# Test PINGMapper
{: .no_toc }

Get `PINGMapper` up and running on your computer.

{: .fs-6 .fw-300 }

---

Once you have [installed](./Installation.md) `PING-Mapper`, you can test the installation by processing two example datasets. The first is a [small](#small-dataset-test) dataset collected in Marble Canyon, AZ, USA. This is the fastest way to see if the software is performing as expected. A second test can be carried out on a [large](#large-dataset-test). The large dataset is included to see how the software performs on a typical sonar recording.

## Small Dataset Test
A quick test can be made to ensure PING-Mapper is working properly.
Expand Down
11 changes: 10 additions & 1 deletion docs/gettingstarted/UpdateInstallation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@ nav_exclude: false

---

# Updating PINGMapper
# Update PINGMapper
{: .no_toc }

Update `PINGMapper` & dependencies to the latest version.

[![PyPI - Version](https://img.shields.io/pypi/v/pingmapper?style=flat-square&label=Latest%20Version%20(PyPi))](https://pypi.org/project/pingmapper/)

{: .fs-6 .fw-300 }

---

{: .g2k }
> As of v4.0, the updating PINGMapper process has been dramatically improved and simplified compared to the [old version](./UpdateInstallation_v1.md)
Expand Down

0 comments on commit 0535b81

Please sign in to comment.