pyadps 0.2.0

A Python package for ADCP data processing

pyadps

pyadps is a Python package for processing moored Acoustic Doppler Current Profiler (ADCP) data. It provides various functionalities such as data reading, quality control tests, NetCDF file creation, and visualization.

This software offers both a graphical interface (Streamlit) for those new to Python and direct Python package access for experienced users. Please note that pyadps is primarily designed for Teledyne RDI workhorse ADCPs. Other company's ADCP files are not compatible, and while some other RDI models may work, they might require additional considerations.

• Documentation: https://pyadps.readthedocs.io
• Source code: https://github.com/p-amol/pyadps
• Bug reports: https://github.com/p-amol/pyadps/issues

Table of Contents

• Installation
• Quick Start
• License

Installation

We recommend installing the package within a virtual environment. At present, the package is compatible exclusively with Python version 3.12. You can create a Python environment using tools like venv or conda. Below are instructions for both methods.

1. Using venv (Built-in Python Tool)

Step 1: Install Python version 3.12 (if not already installed)

Ensure you have Python installed. You can download the latest version from python.org.

Step 2: Create a Virtual Environment

• Open your terminal or command prompt.
• Navigate to your project folder:

cd /path/to/your/project

• Run the following command to create a virtual environment (replace adpsenv with your preferred environment name):

python -m venv adpsenv

Step 3: Activate the Environment

• On Windows:

adpsenv\Scripts\activate

• On macOS/Linux:

source adpsenv/bin/activate

You’ll see the environment name in your terminal prompt indicating the environment is active.

Step 4: Install Dependencies

Now you can install packages like this:

pip install pyadps

Step 5: Deactivate the Environment

When you’re done working in the environment, deactivate it by running:

deactivate

2. Using conda (Anaconda/Miniconda)

Step 1: Install Conda

First, you need to have Conda installed on your system. You can either install:

• Anaconda (Full Distribution)
• Miniconda (Lightweight Version)

Step 2: Create a Conda Environment with Python 3.12

Once Conda is installed, open a terminal or command prompt and run the following to create a new environment (replace adpsenv with your preferred environment name):

conda create --name adpsenv python=3.12

Step 3: Activate the Conda Environment

conda activate adpsenv

Step 4: Install pyadps Dependencies

You can install packages with pip inside Conda environments.

pip install pyadps

Step 5: Deactivate the Conda Environment

When done working in the environment, deactivate the environment by running:

conda deactivate

Quick Start

Streamlit web interface

Open a terminal or command prompt, activate the environment, and run the command.

run-pyadps

License

This project is licensed under the MIT License. See the LICENSE file for details.