# 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](#installation)
- [Quick Start](#quick-start)
- [License](#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](https://www.python.org/downloads/).
#### Step 2: Create a Virtual Environment
- Open your terminal or command prompt.
- Navigate to your project folder:
```bash
cd /path/to/your/project
```
- Run the following command to create a virtual environment
(replace adpsenv with your preferred environment name):
```bash
python -m venv adpsenv
```
#### Step 3: Activate the Environment
- On Windows:
```bash
adpsenv\Scripts\activate
```
- On macOS/Linux:
```bash
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:
```bash
pip install pyadps
```
#### Step 5: Deactivate the Environment
When you’re done working in the environment, deactivate it by running:
```bash
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)](https://www.anaconda.com/products/individual)
- [Miniconda (Lightweight Version)](https://docs.conda.io/en/latest/miniconda.html)
#### 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):
```bash
conda create --name adpsenv python=3.12
```
#### Step 3: Activate the Conda Environment
```bash
conda activate adpsenv
```
#### Step 4: Install pyadps Dependencies
You can install packages with pip inside Conda environments.
```bash
pip install pyadps
```
#### Step 5: Deactivate the Conda Environment
When done working in the environment, deactivate the environment by running:
```bash
conda deactivate
```
## Quick Start
### Streamlit web interface
Open a terminal or command prompt, activate the environment, and run the command.
```bash
run-pyadps
```
## License
This project is licensed under the MIT License. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://example.com",
"name": "pyadps",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.12",
"maintainer_email": null,
"keywords": "adcp, data-processing, oceanography",
"author": "P. Amol",
"author_email": "prakashamol@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/ee/e6245e43ac9209c4a5ba6284b7189569d96f1ebef1d1bc573d7575f61aa4/pyadps-0.2.1b0.tar.gz",
"platform": null,
"description": "# pyadps\n\n`pyadps` is a Python package for processing moored Acoustic Doppler\nCurrent Profiler (ADCP) data. It provides various functionalities\nsuch as data reading, quality control tests, NetCDF file creation,\nand visualization.\n\nThis software offers both a graphical interface (`Streamlit`) for\nthose new to Python and direct Python package access for experienced\nusers. Please note that `pyadps` is primarily designed for Teledyne\nRDI workhorse ADCPs. Other company's ADCP files are not compatible,\nand while some other RDI models may work, they might require additional\nconsiderations.\n\n- Documentation: <https://pyadps.readthedocs.io>\n- Source code: <https://github.com/p-amol/pyadps>\n- Bug reports: <https://github.com/p-amol/pyadps/issues>\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [License](#license)\n\n## Installation\n\nWe recommend installing the package within a virtual environment.\nAt present, the package is compatible exclusively with Python version 3.12.\nYou can create a Python environment using tools like `venv` or `conda`.\nBelow are instructions for both methods.\n\n### 1. Using `venv` (Built-in Python Tool)\n\n#### Step 1: Install Python version 3.12 (if not already installed)\n\nEnsure you have Python installed. You can download the latest version from [python.org](https://www.python.org/downloads/).\n\n#### Step 2: Create a Virtual Environment\n\n- Open your terminal or command prompt.\n- Navigate to your project folder:\n\n```bash\ncd /path/to/your/project\n```\n\n- Run the following command to create a virtual environment\n(replace adpsenv with your preferred environment name):\n\n```bash\npython -m venv adpsenv\n```\n\n#### Step 3: Activate the Environment\n\n- On Windows:\n\n```bash\nadpsenv\\Scripts\\activate\n```\n\n- On macOS/Linux:\n\n```bash\nsource adpsenv/bin/activate\n```\n\nYou\u2019ll see the environment name in your terminal prompt\nindicating the environment is active.\n\n#### Step 4: Install Dependencies\n\nNow you can install packages like this:\n\n```bash\npip install pyadps\n```\n\n#### Step 5: Deactivate the Environment\n\nWhen you\u2019re done working in the environment, deactivate it by running:\n\n```bash\ndeactivate\n```\n\n### 2. Using `conda` (Anaconda/Miniconda)\n\n#### Step 1: Install Conda\n\nFirst, you need to have Conda installed on your system. You can either install:\n\n- [Anaconda (Full Distribution)](https://www.anaconda.com/products/individual)\n- [Miniconda (Lightweight Version)](https://docs.conda.io/en/latest/miniconda.html)\n\n#### Step 2: Create a Conda Environment with Python 3.12\n\nOnce Conda is installed, open a terminal or command prompt and run\nthe following to create a new environment (replace `adpsenv` with\nyour preferred environment name):\n\n```bash\nconda create --name adpsenv python=3.12\n```\n\n#### Step 3: Activate the Conda Environment\n\n```bash\nconda activate adpsenv\n```\n\n#### Step 4: Install pyadps Dependencies\n\nYou can install packages with pip inside Conda environments.\n\n```bash\npip install pyadps\n```\n\n#### Step 5: Deactivate the Conda Environment\n\nWhen done working in the environment, deactivate the environment by running:\n\n```bash\nconda deactivate\n```\n\n## Quick Start\n\n### Streamlit web interface\n\nOpen a terminal or command prompt, activate the environment, and run the command.\n\n```bash\nrun-pyadps\n```\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python package for ADCP data processing",
"version": "0.2.1b0",
"project_urls": {
"Documentation": "https://example.com/docs",
"Homepage": "https://example.com",
"Repository": "https://github.com/p-amol/pyadps"
},
"split_keywords": [
"adcp",
" data-processing",
" oceanography"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11bfbecdcdf723b9a8bf02d404f52416581d9cc8a4be7a5947fb4d8239f1962b",
"md5": "f0bb3ada7ea7d9392fc6f51abc1785a8",
"sha256": "7e8d4749a1dc9e599ebb1b2a520f48978806d3518b92cc0a97115e75fce20dbb"
},
"downloads": -1,
"filename": "pyadps-0.2.1b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0bb3ada7ea7d9392fc6f51abc1785a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.12",
"size": 71268,
"upload_time": "2024-12-06T07:11:56",
"upload_time_iso_8601": "2024-12-06T07:11:56.219687Z",
"url": "https://files.pythonhosted.org/packages/11/bf/becdcdf723b9a8bf02d404f52416581d9cc8a4be7a5947fb4d8239f1962b/pyadps-0.2.1b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38eee6245e43ac9209c4a5ba6284b7189569d96f1ebef1d1bc573d7575f61aa4",
"md5": "096c24a63bd4274ea6320fee0e1c72ac",
"sha256": "e7107b9905f0b1f72a2410a21fe0a1c05aff847a1819098342a347fd55153c61"
},
"downloads": -1,
"filename": "pyadps-0.2.1b0.tar.gz",
"has_sig": false,
"md5_digest": "096c24a63bd4274ea6320fee0e1c72ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.12",
"size": 60401,
"upload_time": "2024-12-06T07:11:58",
"upload_time_iso_8601": "2024-12-06T07:11:58.909222Z",
"url": "https://files.pythonhosted.org/packages/38/ee/e6245e43ac9209c4a5ba6284b7189569d96f1ebef1d1bc573d7575f61aa4/pyadps-0.2.1b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 07:11:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "p-amol",
"github_project": "pyadps",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyadps"
}
JSON
