pyadps 0.2.0b0__tar.gz → 0.3.0__tar.gz

{pyadps-0.2.0b0 → pyadps-0.3.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pyadps
-Version: 0.2.0b0
+Version: 0.3.0
 Summary: A Python package for ADCP data processing
-Home-page: https://example.com
 License: MIT
 Keywords: adcp,data-processing,oceanography
 Author: P. Amol
@@ -13,27 +12,39 @@ 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: matplotlib (>=3.8.4,<3.9.0)
 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: scipy (>=1.14.0)
-Requires-Dist: streamlit (>=1.36.0)
-Requires-Dist: wmm2020 (>=1.1.1)
-Project-URL: Documentation, https://example.com/docs
+Requires-Dist: netCDF4 (>=1.7.1,<1.8.0)
+Requires-Dist: numpy (>=1.26.4,<1.27.0)
+Requires-Dist: pandas (>=2.2.2,<2.3.0)
+Requires-Dist: plotly (>=5.22.0,<5.23.0)
+Requires-Dist: plotly-resampler (>=0.10.0,<0.11.0)
+Requires-Dist: pygeomag (>=1.1.0,<2.0.0)
+Requires-Dist: scipy (>=1.14.0,<1.15.0)
+Requires-Dist: streamlit (>=1.36.0,<1.37.0)
+Project-URL: Documentation, https://pyadps.readthedocs.io/en/latest/index.html
 Project-URL: Repository, https://github.com/p-amol/pyadps
+Project-URL: homepage, https://pyadps.readthedocs.io/en/latest/index.html
 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.
+`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.
+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
 
@@ -43,37 +54,49 @@ This software offers both a graphical interface (`Streamlit`) for those new to P
 
 ## 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.
+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 
+#### 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):
+
+- 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.
+
+You’ll see the environment name in your terminal prompt
+indicating the environment is active.
 
 #### Step 4: Install Dependencies
 
@@ -84,44 +107,51 @@ 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):
+### 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):
+
+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 Environment
+#### Step 3: Activate the Conda Environment
+
 ```bash
 conda activate adpsenv
 ```
 
-#### Step 4: Install Dependencies
-You can install packages with pip inside Conda environments. 
+#### Step 4: Install pyadps Dependencies
+
+You can install packages with pip inside Conda environments.
+
 ```bash
 pip install pyadps
 ```
 
-#### Step 5: Deactivate the Environment
-When done, deactivate the environment by running:
-```
+#### Step 5: Deactivate the Conda Environment
+
+When done working in the environment, deactivate the environment by running:
+
+```bash
 conda deactivate
 ```
 
@@ -130,11 +160,11 @@ conda deactivate
 ### 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.2.0b0 → pyadps-0.3.0}/README.md

@@ -1,8 +1,20 @@
 # 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.
+`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
 
@@ -12,37 +24,49 @@ This software offers both a graphical interface (`Streamlit`) for those new to P
 
 ## 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.
+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 
+#### 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):
+
+- 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.
+
+You’ll see the environment name in your terminal prompt
+indicating the environment is active.
 
 #### Step 4: Install Dependencies
 
@@ -53,44 +77,51 @@ 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):
+### 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):
+
+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 Environment
+#### Step 3: Activate the Conda Environment
+
 ```bash
 conda activate adpsenv
 ```
 
-#### Step 4: Install Dependencies
-You can install packages with pip inside Conda environments. 
+#### Step 4: Install pyadps Dependencies
+
+You can install packages with pip inside Conda environments.
+
 ```bash
 pip install pyadps
 ```
 
-#### Step 5: Deactivate the Environment
-When done, deactivate the environment by running:
-```
+#### Step 5: Deactivate the Conda Environment
+
+When done working in the environment, deactivate the environment by running:
+
+```bash
 conda deactivate
 ```
 
@@ -99,11 +130,11 @@ conda deactivate
 ### 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.0/pyproject.toml

@@ -0,0 +1,46 @@
+[tool.poetry]
+name = "pyadps"
+version = "0.3.0"
+description = "A Python package for ADCP data processing"
+authors = ["P. Amol <prakashamol@gmail.com>"]
+readme = "README.md"
+license = "MIT"
+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.urls]
+homepage = "https://pyadps.readthedocs.io/en/latest/index.html"
+Documentation = "https://pyadps.readthedocs.io/en/latest/index.html"
+Repository = "https://github.com/p-amol/pyadps"
+
+[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.group.dev.dependencies]
+pytest = "^7.4"
+ruff = "^0.5.0"
+
+[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.0/src/pyadps/Home_Page.py

@@ -0,0 +1,48 @@
+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": "https://github.com/p-amol/pyadps",
+            "Report a bug": "https://github.com/p-amol/pyadps/issues",
+            "About": "# Python ADCP Data Processing Software (PyADPS)",
+        },
+    )
+
+    """
+    # **Python ADCP Data Processing Software (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
+    ## Features
+
+    * Access RDI ADCP binary files using Python 3
+    * Convert RDI binary files to netcdf
+    * Process ADCP data 
+
+    ## Contribute
+    Issue Tracker: https://github.com/p-amol/pyadps/issues
+    Source Code: https://github.com/p-amol/pyadps
+
+    ## 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()