hfpytrace 0.0.1__tar.gz

hfpytrace-0.0.1/.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+# Run unit tests and publish coverage to Codecov
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[dev]"
+        shell: bash
+
+      - name: Run tests with coverage
+        run: |
+          pytest
+        shell: bash
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
+          verbose: true

hfpytrace-0.0.1/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

hfpytrace-0.0.1/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# # Set the version of Python and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+

hfpytrace-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shibaji Chakraborty
+
+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.

hfpytrace-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include pynasonde *.toml *.csv *.dtd

hfpytrace-0.0.1/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.2
+Name: hfpytrace
+Version: 0.0.1
+Summary: Precision ionospheric radio wave propagation tools
+Home-page: https://github.com/shibaji7/trace
+Author: Shibaji Chakraborty
+Author-email: chakras4@erau.edu
+Maintainer: Shibaji Chakraborty
+Maintainer-email: chakras4@erau.edu
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
+Requires-Dist: pandas; extra == "dev"
+Requires-Dist: matplotlib; extra == "dev"
+Requires-Dist: pytesseract; extra == "dev"
+Requires-Dist: loguru; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Requires-Dist: beautifulsoup4; extra == "dev"
+Requires-Dist: tqdm; extra == "dev"
+Requires-Dist: lxml; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Requires-Dist: pytz; extra == "dev"
+Requires-Dist: SciencePlots; extra == "dev"
+Requires-Dist: scipy; extra == "dev"
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: maintainer
+Dynamic: maintainer-email
+
+
+# pyTrace
+<div style="text-align: center;">
+  <!-- <img src="docs/assets/Colab-pynasonde-logo2.jpg" alt="Pynasonde" width="50%"> -->
+</div>
+
+[![License: MIT](https://img.shields.io/badge/License%3A-MIT-green)](https://choosealicense.com/licenses/mit/) 
+[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/) 
+![GitHub Stable Release (latest by date)](https://img.shields.io/github/v/release/shibaji7/pytrace)
+[![Documentation Status](https://img.shields.io/readthedocs/pytrace?logo=readthedocs&label=docs)](https://pytrace.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/shibaji7/pytrace/branch/main/graph/badge.svg)](https://codecov.io/gh/shibaji7/pytrace)
+
+
+Pynasonde is an open-source Python-based application designed for precision ionospheric radio sounding, with a strong focus on analyzing the phase characteristics of radio echoes. Tailored for Space Weather applications, Pynasonde offers a suite of unique tools that help extract valuable insights directly and autonomously from ionogram data.
+
+With Pynasonde, you can achieve accurate echo recognition, noise discrimination, and echo classification into traces. The application also facilitates the scaling of standard ionospheric parameters, 3-D plasma density inversion (including error bars), diagnostics of small-scale irregularities, and determination of vector velocities.
+
+Designed as a comprehensive toolbox, Pynasonde empowers researchers to process raw ionosonde datasets efficiently, providing reliable, real-time insights into ionospheric conditions and phenomena. Whether you're focused on space weather forecasting, radio communication, or scientific exploration, Pynasonde is your go-to tool for precision ionospheric analysis.
+
+## Source Code 
+
+The library source code can be found on the [pytrace GitHub](https://github.com/shibaji7/pytrace) repository. 
+
+If you have any questions or concerns please submit an **Issue** on the [pytrace GitHub](https://github.com/shibaji7/pytrace) repository. 
+
+## Documentation
+Read the docs: https://pytrace.readthedocs.io/en/latest/

hfpytrace-0.0.1/README.md

@@ -0,0 +1,27 @@
+
+# pyTrace
+<div style="text-align: center;">
+  <!-- <img src="docs/assets/Colab-pynasonde-logo2.jpg" alt="Pynasonde" width="50%"> -->
+</div>
+
+[![License: MIT](https://img.shields.io/badge/License%3A-MIT-green)](https://choosealicense.com/licenses/mit/) 
+[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/) 
+![GitHub Stable Release (latest by date)](https://img.shields.io/github/v/release/shibaji7/pytrace)
+[![Documentation Status](https://img.shields.io/readthedocs/pytrace?logo=readthedocs&label=docs)](https://pytrace.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/shibaji7/pytrace/branch/main/graph/badge.svg)](https://codecov.io/gh/shibaji7/pytrace)
+
+
+Pynasonde is an open-source Python-based application designed for precision ionospheric radio sounding, with a strong focus on analyzing the phase characteristics of radio echoes. Tailored for Space Weather applications, Pynasonde offers a suite of unique tools that help extract valuable insights directly and autonomously from ionogram data.
+
+With Pynasonde, you can achieve accurate echo recognition, noise discrimination, and echo classification into traces. The application also facilitates the scaling of standard ionospheric parameters, 3-D plasma density inversion (including error bars), diagnostics of small-scale irregularities, and determination of vector velocities.
+
+Designed as a comprehensive toolbox, Pynasonde empowers researchers to process raw ionosonde datasets efficiently, providing reliable, real-time insights into ionospheric conditions and phenomena. Whether you're focused on space weather forecasting, radio communication, or scientific exploration, Pynasonde is your go-to tool for precision ionospheric analysis.
+
+## Source Code 
+
+The library source code can be found on the [pytrace GitHub](https://github.com/shibaji7/pytrace) repository. 
+
+If you have any questions or concerns please submit an **Issue** on the [pytrace GitHub](https://github.com/shibaji7/pytrace) repository. 
+
+## Documentation
+Read the docs: https://pytrace.readthedocs.io/en/latest/

hfpytrace-0.0.1/configure.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+
+import argparse
+import os
+import shutil
+
+
+def clean():
+    os.system("python setup.py clean --all")
+    os.system(
+        "rm -rf dist site_build site junit.xml .coverage coverage.xml .pytest_cache .eggs"
+    )
+    os.system("rm -rf build *.egg-info")
+    if os.path.exists("dist/"):
+        shutil.rmtree("dist/")
+    if os.path.exists("build/"):
+        shutil.rmtree("build/")
+    os.system("find . -type d -name '.ipynb_checkpoints' -exec rm -rf {} +")
+    os.system("find . -type d -name '__pycache__' -exec rm -rf {} +")
+    os.system("isort -rc -sl .")
+    os.system("autoflake --in-place .")
+    os.system("isort -rc -m 3 .")
+    os.system("black .")
+    os.system("pip install -e .[dev]")
+    return
+
+
+def build():
+    clean()
+    os.system("isort -rc -sl .")
+    os.system(
+        "autoflake --in-place --remove-all-unused-imports=False --imports=SDCarto,scienceplots ."
+    )
+    os.system("isort -rc -m 3 .")
+    os.system("black .")
+    os.system("python setup.py sdist bdist_wheel")
+    return
+
+
+def uplaod_pip():
+    clean()
+    build()
+    os.system("python -m twine upload dist/* --verbose")
+    return
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-b", "--build", action="store_true", help="Build the project from scratch"
+    )
+    parser.add_argument(
+        "-rm", "--clean", action="store_true", help="Cleaning pre-existing files"
+    )
+    parser.add_argument(
+        "-rb",
+        "--rebuild",
+        action="store_true",
+        help="Clean and rebuild the project from scratch",
+    )
+    parser.add_argument(
+        "-upip",
+        "--upip",
+        action="store_true",
+        help="Upload code to PIP repository",
+    )
+    args = parser.parse_args()
+    if args.clean:
+        clean()
+    if args.build:
+        build()
+    if args.rebuild:
+        clean()
+        build()
+    if args.upip:
+        uplaod_pip()

hfpytrace-0.0.1/docs/assets/dataprod.dot

@@ -0,0 +1,62 @@
+digraph DigisondeWorkflow {
+  graph [
+    rankdir=TB,
+    splines=ortho,
+    nodesep=0.6,
+    ranksep=0.8,
+    bgcolor="white"
+  ];
+
+  node [
+    shape=box,
+    style="rounded,filled",
+    fontname="Helvetica",
+    fontsize=14,
+    fillcolor="white",
+    color="black",
+    penwidth=1.8
+  ];
+
+  edge [
+    arrowsize=0.9,
+    penwidth=1.8
+  ];
+
+  // Nodes
+  RAW [label="Raw waveforms"];
+
+  RSF_SBF [label=<
+    <B>RSF / SBF</B><BR/>
+    <FONT POINT-SIZE="11">Range–frequency representation<br/>Echo detection</FONT>
+  >];
+
+  DFT [label=<
+    <B>DFT</B><BR/>
+    <FONT POINT-SIZE="11">Doppler-resolved spectra</FONT>
+  >];
+
+  SKY [label=<
+    <B>SKY</B><BR/>
+    <FONT POINT-SIZE="11">Direction-of-arrival<br/>Skymaps</FONT>
+  >];
+
+  DVL [label=<
+    <B>DVL</B><BR/>
+    <FONT POINT-SIZE="11">Bulk Doppler<br/>velocity diagnostics</FONT>
+  >];
+
+  SAO [label=<
+    <B>SAO</B><BR/>
+    <FONT POINT-SIZE="11">Scaled ionospheric<br/>parameters</FONT>
+  >];
+
+  // Main workflow
+  RAW -> RSF_SBF;
+  RAW -> DFT;
+  DFT -> SKY [label="DFT2SKY", fontsize=11];
+  SKY -> DVL;
+
+  // Parallel branch to SAO
+  RSF_SBF -> SAO [label="ARTIST5.0", fontsize=11];
+
+}

hfpytrace-0.0.1/docs/css/pynasonde.css

@@ -0,0 +1,63 @@
+table th {
+    background-color: hsl(348, 100%, 65%);
+    color: white;
+    align: left;
+    font-weight: bold;
+}
+
+table td {
+    background-color: hsl(217, 71%, 90%);
+    align: left;
+}
+
+turquoise=sl(171, 100%, 41%)
+blue=hsl(217, 71%, 53%)
+green=hsl(141, 71%, 48%)
+yellow=hsl(48, 100%, 67%)
+red=hsl(348, 100%, 61%)
+grey=hsl(0, 3%, 50%)
+
+
+blockquote {
+    border-left: 5px solid turquoise;
+    background: hsl(171, 100%, 90%);
+    padding: 10px 30px 10px
+}
+
+.is-parameter {
+    border-left: 5px solid grey;
+    background: hsl(0, 3%, 90%);
+    padding: 10px 50px 10px 
+}
+
+.is-primary {
+    border-left: 5px solid turquoise;
+    background: hsl(171, 100%, 90%);
+    padding: 10px 30px 10px 
+}
+
+.is-info {
+    border-left: 5px solid blue;
+    background: hsl(217, 71%, 90%);
+    padding: 10px 30px 10px 
+}
+
+.is-feature {
+    border-color: green;
+    background: hsl(141, 71%, 90%)
+}
+
+.is-note {
+    border-color: yellow;
+    background: hsl(48, 100%, 90%)
+}
+
+.is-warning {
+    border-color: blue;
+    background: hsl(348, 100%, 90%)
+}
+
+tr:nth-child(even) {
+  background-color: #b2b2b2!important;
+  color: #f4f4f4!important;
+}