pyadps 0.3.3b0__tar.gz

pyadps-0.3.3b0/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2024 <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pyadps-0.3.3b0/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.3
+Name: pyadps
+Version: 0.3.3b0
+Summary: A Python package for ADCP data processing
+Home-page: https://example.com
+License: MIT
+Keywords: adcp,data-processing,oceanography
+Author: P. Amol
+Author-email: prakashamol@gmail.com
+Requires-Python: >=3.12,<4.0.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: tests
+Requires-Dist: cmake (>=3.30.2)
+Requires-Dist: matplotlib (>=3.8.4)
+Requires-Dist: meson (>=1.4.1)
+Requires-Dist: netCDF4 (>=1.7.1)
+Requires-Dist: numpy (>=1.26.4)
+Requires-Dist: pandas (>=2.2.2)
+Requires-Dist: plotly (>=5.22.0)
+Requires-Dist: plotly-resampler (>=0.10.0)
+Requires-Dist: pygeomag (>=1.1.0,<2.0.0)
+Requires-Dist: scipy (>=1.14.0)
+Requires-Dist: streamlit (>=1.36.0)
+Project-URL: Documentation, https://example.com/docs
+Project-URL: Repository, https://github.com/p-amol/pyadps
+Description-Content-Type: text/markdown
+
+# 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.
+

pyadps-0.3.3b0/README.md

@@ -0,0 +1,140 @@
+# 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.

pyadps-0.3.3b0/pyproject.toml

@@ -0,0 +1,45 @@
+[tool.poetry]
+name = "pyadps"
+version = "0.3.3-beta"
+description = "A Python package for ADCP data processing"
+authors = ["P. Amol <prakashamol@gmail.com>"]
+readme = "README.md"
+license = "MIT"
+homepage = "https://example.com" # You can add your homepage URL or GitHub URL here
+repository = "https://github.com/p-amol/pyadps" # Replace with your repository link
+documentation = "https://example.com/docs" # Optional documentation link
+keywords = ["adcp", "data-processing", "oceanography"]
+include = ["utils/metadata/*.json"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+
+[tool.poetry.dependencies]
+python = "<4.0.0,>=3.12"
+streamlit = ">=1.36.0"
+numpy = ">=1.26.4"
+matplotlib = ">=3.8.4"
+scipy = ">=1.14.0"
+cmake = ">=3.30.2"
+pandas = ">=2.2.2"
+netCDF4 = ">=1.7.1"
+plotly = ">=5.22.0"
+plotly-resampler = ">=0.10.0"
+meson = ">=1.4.1"
+pygeomag = "^1.1.0"
+
+
+[tool.poetry.extras]
+tests = ["pytest"]
+
+[tool.poetry.scripts]
+run-pyadps = "pyadps.__main__:main"
+run-auto = "pyadps.utils.autoprocess:main"
+run-script = "pyadps.utils.script:main"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

pyadps-0.3.3b0/src/pyadps/Home_Page.py

@@ -0,0 +1,42 @@
+import streamlit as st
+
+
+def main():
+    st.set_page_config(
+        page_title="ADCP Data Processing Software",
+        page_icon=":world_map:️",
+        layout="wide",
+        initial_sidebar_state="auto",
+        menu_items={
+            "Get Help": "http://github.com/p-amol/adps",
+            "Report a bug": "http://github.com/adps/issues",
+            "About": "# Python ADCP Data Processing Software (PyADPS)",
+        },
+    )
+
+    """
+    # **Python ADCP Data Processing Software (pyadps)**
+    `pyadps` is a software for processing Teledyne RDI Acoustic Doppler Current Profiler (ADCP) PD0 files. Currently the software can process the data from Workhorse ADCPs.
+
+    ## Features
+
+    * Access RDI ADCP binary files using Python 3
+    * Convert RDI binary files to netcdf
+    * Process ADCP data 
+
+    ## Contribute
+    Issue Tracker: http://github.com/adps/issues
+    Source Code: http://github.com/p-amol/adps
+
+    ## Support
+    If you are having issues, please let us know.
+    We have a mailing list located at: adps-python@google-groups.com
+    
+    ## License
+    The project is licensed under the MIT license.
+
+    """
+
+
+if __name__ == "__main__":
+    main()

pyadps-0.3.3b0/src/pyadps/__init__.py

@@ -0,0 +1,8 @@
+#import utils.pyreadrdi
+#import utils.readrdi
+# pyadps/__init__.py
+
+# Importing main modules and functions to simplify access
+from pyadps.Home_Page import main as show_home_page
+from pyadps.pages import *
+from pyadps.utils import *

pyadps-0.3.3b0/src/pyadps/__main__.py

@@ -0,0 +1,15 @@
+# pyadps/__main__.py
+
+import subprocess
+import os
+
+def main():
+    # Get the absolute path to Home_Page.py
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    home_page_path = os.path.join(current_dir, 'Home_Page.py')
+
+    # Run the Streamlit app
+    subprocess.run(["streamlit", "run", home_page_path])
+
+if __name__ == "__main__":
+    main()