radarx 0.1.dev2__tar.gz

radarx-0.1.dev2/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Hamid Ali Syed <hamidsyed37@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

radarx-0.1.dev2/CONTRIBUTING.rst

@@ -0,0 +1,137 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/syedhamidali/radarx/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+radarx could always use more documentation, whether as part of the
+official radarx docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/syedhamidali/radarx/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `radarx` for local development.
+
+1. Fork the `radarx` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/radarx.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv radarx
+    $ cd radarx/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ make lint
+    $ make test
+    Or
+    $ make test-all
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/syedhamidali/radarx/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_radarx
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.
+
+Code of Conduct
+---------------
+
+Please note that this project is released with a `Contributor Code of Conduct`_.
+By participating in this project you agree to abide by its terms.
+
+.. _`Contributor Code of Conduct`: CODE_OF_CONDUCT.rst

radarx-0.1.dev2/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2024-09-06)
+------------------
+
+* First release on PyPI.

radarx-0.1.dev2/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, Hamid Ali Syed
+
+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.
+

radarx-0.1.dev2/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

radarx-0.1.dev2/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: radarx
+Version: 0.1.dev2
+Summary: Xarray based radar toolkit
+Author-email: Hamid Ali Syed <hamidsyed37@gmail.com>
+Maintainer-email: Hamid Ali Syed <hamidsyed37@gmail.com>
+License: MIT license
+Project-URL: bugs, https://github.com/syedhamidali/radarx/issues
+Project-URL: changelog, https://github.com/syedhamidali/radarx/blob/master/changelog.md
+Project-URL: homepage, https://github.com/syedhamidali/radarx
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+License-File: LICENSE
+License-File: AUTHORS.rst
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"

radarx-0.1.dev2/README.md

@@ -0,0 +1 @@
+# RadarX

radarx-0.1.dev2/README.rst

@@ -0,0 +1,41 @@
+======
+radarx
+======
+
+
+.. image:: https://img.shields.io/pypi/v/radarx.svg
+        :target: https://pypi.python.org/pypi/radarx
+
+.. image:: https://img.shields.io/travis/syedhamidali/radarx.svg
+        :target: https://travis-ci.com/syedhamidali/radarx
+
+.. image:: https://readthedocs.org/projects/radarx/badge/?version=latest
+        :target: https://radarx.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+.. image:: https://pyup.io/repos/github/syedhamidali/radarx/shield.svg
+     :target: https://pyup.io/repos/github/syedhamidali/radarx/
+     :alt: Updates
+
+
+
+Xarray based radar toolkit
+
+
+* Free software: MIT license
+* Documentation: https://radarx.readthedocs.io.
+
+
+Features
+--------
+
+* TODO
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

radarx-0.1.dev2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = radarx
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

radarx-0.1.dev2/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst

radarx-0.1.dev2/docs/conf.py

@@ -0,0 +1,253 @@
+#!/usr/bin/env python
+#
+# radarx documentation build configuration file, created by
+# sphinx-quickstart.
+#
+import datetime as dt
+import glob
+import os
+import subprocess
+import sys
+import warnings
+from importlib.metadata import version
+
+sys.path.insert(0, os.path.abspath(".."))
+
+# check readthedocs
+on_rtd = os.environ.get("READTHEDOCS") == "True"
+
+# processing on readthedocs
+if on_rtd:
+    # install radarx from checked out source
+    commit = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode().strip()
+    print(f"Installing commit {commit}")
+    url = "https://github.com/syedhamidali/radarx.git"
+    subprocess.check_call(
+        ["python", "-m", "pip", "install", "--no-deps", f"git+{url}@{commit}"]
+    )
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.coverage",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.todo",
+    "myst_parser",
+    "sphinx_copybutton",
+    "sphinx_favicon",
+    "nbsphinx",
+]
+
+myst_enable_extensions = [
+    "substitution",
+]
+
+extlinks = {
+    "issue": ("https://github.com/syedhamidali/radarx/issues/%s", "GH %s"),
+    "pull": ("https://github.com/syedhamidali/radarx/pull/%s", "PR %s"),
+}
+
+mathjax_path = (
+    "https://cdn.mathjax.org/mathjax/latest/MathJax.js?" "config=TeX-AMS-MML_HTMLorMML"
+)
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
+    "datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None),
+    "pyproj": ("https://pyproj4.github.io/pyproj/stable/", None),
+}
+
+templates_path = ["_templates"]
+
+source_suffix = [".rst", ".md"]
+
+master_doc = "index"
+
+project = "radarx"
+copyright = "2022-2024, Hamid Ali Syed"
+author = "Hamid Ali Syed"
+
+# Get radarx version and modules
+import radarx  # noqa
+
+modules = []
+for k, v in radarx.__dict__.items():
+    if isinstance(v, types.ModuleType):
+        if k not in ["_warnings", "version"]:
+            modules.append(k)
+            file = open(f"{k}.rst", mode="w")
+            file.write(f".. automodule:: radarx.{k}\n")
+            file.close()
+
+# Create Library reference rst-file
+reference = """
+Library Reference
+=================
+
+.. toctree::
+   :maxdepth: 4
+"""
+
+file = open("reference.rst", mode="w")
+file.write(f"{reference}\n")
+for mod in sorted(modules):
+    file.write(f"   {mod}\n")
+file.close()
+
+rst_files = glob.glob("*.rst")
+autosummary_generate = rst_files
+autoclass_content = "both"
+
+version = version("radarx")
+release = version
+
+myst_substitutions = {
+    "today": dt.datetime.utcnow().strftime("%Y-%m-%d"),
+    "release": release,
+}
+myst_heading_anchors = 3
+
+language = "en"
+
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "links.rst",
+    "**.ipynb_checkpoints",
+]
+
+pygments_style = "sphinx"
+
+todo_include_todos = False
+
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+
+# -- nbsphinx specifics --
+nbsphinx_execute = "always"
+subprocess.check_call(["cp", "-rp", "../examples/notebooks", "."])
+
+# -- Options for HTML output -------------------------------------------
+html_theme = "pydata_sphinx_theme"
+# html_logo = "_static/radarx_logo.svg"
+
+def _custom_edit_url(
+    github_user,
+    github_repo,
+    github_version,
+    docpath,
+    filename,
+    default_edit_page_url_template,
+):
+    if filename.startswith("generated/"):
+        modpath = os.sep.join(
+            os.path.splitext(filename)[0].split("/")[-1].split(".")[:-1]
+        )
+        if modpath == "modules":
+            modpath = "radarx"
+        rel_modpath = os.path.join("..", modpath)
+        if os.path.isdir(rel_modpath):
+            docpath = modpath + "/"
+            filename = "__init__.py"
+        elif os.path.isfile(rel_modpath + ".py"):
+            docpath = os.path.dirname(modpath)
+            filename = os.path.basename(modpath) + ".py"
+        else:
+            warnings.warn(f"Not sure how to generate the API URL for: {filename}")
+    return default_edit_page_url_template.format(
+        github_user=github_user,
+        github_repo=github_repo,
+        github_version=github_version,
+        docpath=docpath,
+        filename=filename,
+    )
+
+html_context = {
+    "github_url": "https://github.com",
+    "github_user": "syedhamidali",
+    "github_repo": "radarx",
+    "github_version": "main",
+    "doc_path": "docs",
+    "edit_page_url_template": "{{ radarx_custom_edit_url(github_user, github_repo, github_version, doc_path, file_name, default_edit_page_url_template) }}",
+    "default_edit_page_url_template": "https://github.com/{github_user}/{github_repo}/edit/{github_version}/{docpath}/{filename}",
+    "radarx_custom_edit_url": _custom_edit_url,
+}
+
+html_theme_options = {
+    "announcement": "<p>radarx is in an early stage of development, please report any issues <a href='https://github.com/syedhamidali/radarx/issues'>here!</a></p>",
+    "github_url": "https://github.com/syedhamidali/radarx",
+    "icon_links": [
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/radarx",
+            "icon": "fas fa-box",
+        },
+        {
+            "type": "local",
+            "name": "syedhamidali",
+            "url": "https://syedha.com",
+            # "icon": "_static/syedhamidali_micro.svg",
+        },
+    ],
+    "navbar_end": ["theme-switcher", "icon-links.html"],
+    "use_edit_page_button": True,
+}
+
+html_static_path = ["_static"]
+
+# favicons = [
+#     {
+#         "rel": "icon",
+#         "sizes": "16x16",
+#         "href": "openradar_micro.svg",
+#     },
+#     {
+#         "rel": "icon",
+#         "sizes": "32x32",
+#         "href": "openradar_micro.svg",
+#     },
+# ]
+
+htmlhelp_basename = "radarxdoc"
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_special_with_doc = False
+napoleon_use_param = False
+napoleon_use_rtype = False
+napoleon_preprocess_types = True
+napoleon_type_aliases = {
+    "scalar": ":term:`scalar`",
+    "sequence": ":term:`sequence`",
+    "callable": ":py:func:`callable`",
+    "file-like": ":term:`file-like <file-like object>`",
+    "array-like": ":term:`array-like <array_like>`",
+    "Path": "~~pathlib.Path",
+}
+
+man_pages = [(master_doc, "radarx", "radarx Documentation", [author], 1)]
+
+texinfo_documents = [
+    (
+        master_doc,
+        "radarx",
+        "radarx Documentation",
+        author,
+        "radarx",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
+
+rst_epilog = ""
+with open("links.rst") as f:
+    rst_epilog += f.read()

radarx-0.1.dev2/docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

radarx-0.1.dev2/docs/history.rst

@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst

radarx-0.1.dev2/docs/index.rst

@@ -0,0 +1,20 @@
+Welcome to radarx's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme
+   installation
+   usage
+   modules
+   contributing
+   authors
+   history
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

radarx-0.1.dev2/docs/installation.rst

@@ -0,0 +1,51 @@
+.. highlight:: shell
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install radarx, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install radarx
+
+This is the preferred method to install radarx, as it will always install the most recent stable release.
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for radarx can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone git://github.com/syedhamidali/radarx
+
+Or download the `tarball`_:
+
+.. code-block:: console
+
+    $ curl -OJL https://github.com/syedhamidali/radarx/tarball/master
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/syedhamidali/radarx
+.. _tarball: https://github.com/syedhamidali/radarx/tarball/master

radarx-0.1.dev2/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=radarx
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

radarx-0.1.dev2/docs/readme.rst

@@ -0,0 +1 @@
+.. include:: ../README.rst

radarx-0.1.dev2/docs/usage.rst

@@ -0,0 +1,7 @@
+=====
+Usage
+=====
+
+To use radarx in a project::
+
+    import radarx