sparrowpy 0.1.0__py3-none-any.whl

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    = sparrowpy
+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)

docs/api_reference.rst

@@ -0,0 +1,25 @@
+.. _api_reference:
+
+API Reference
+=============
+
+The following gives detailed information about all sparrowpy functions sorted
+according to their modules.
+
+For examples on how to use sparrowpy refer to the notebooks in the
+`examples gallery`_ and the documentation on classes and modules below.
+
+
+Modules
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   modules/sparrowpy.radiosity
+   modules/sparrowpy.geometry
+   modules/sparrowpy.sound_object
+   modules/sparrowpy.brdf
+
+
+.. _examples gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html

docs/conf.py

@@ -0,0 +1,185 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+import urllib3
+import shutil
+sys.path.insert(0, os.path.abspath('..'))
+
+import sparrowpy  # noqa
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autosummary',
+    'matplotlib.sphinxext.plot_directive',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.intersphinx',
+    'autodocsumm',
+    'sphinx_design',
+    'sphinx_favicon',
+    'sphinx_reredirects',
+    'sphinx_mdinclude',
+]
+
+# show tocs for classes and functions of modules using the autodocsumm
+# package
+autodoc_default_options = {'autosummary': True}
+
+# show the code of plots that follows the command .. plot:: based on the
+# package matplotlib.sphinxext.plot_directive
+plot_include_source = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'sparrowpy'
+copyright = "2024, The pyfar developers"
+author = "The pyfar developers"
+
+# The version info for the project you're documenting, acts as replacement
+# for |version| and |release|, also used in various other places throughout
+# the built documents.
+#
+# The short X.Y version.
+version = sparrowpy.__version__
+# The full version, including alpha/beta/rc tags.
+release = sparrowpy.__version__
+
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use (Not defining
+# uses the default style of the html_theme).
+# pygments_style = 'sphinx'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# default language for highlighting in source code
+highlight_language = "python3"
+
+# intersphinx mapping
+intersphinx_mapping = {
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
+    'matplotlib': ('https://matplotlib.org/stable/', None),
+    'pyfar': ('https://pyfar.readthedocs.io/en/stable/', None),
+    }
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'pydata_sphinx_theme'
+html_static_path = ['_static']
+html_css_files = ['css/custom.css']
+html_logo = 'resources/logos/pyfar_logos_fixed_size_sparrowpy.png'
+html_title = "sparrowpy"
+html_favicon = '_static/favicon.ico'
+
+# -- HTML theme options
+# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html
+html_sidebars = {
+  "sparrowpy": []
+}
+
+html_theme_options = {
+    "navbar_start": ["navbar-logo"],
+    "navbar_end": ["navbar-icon-links", "theme-switcher"],
+    "navbar_align": "content",
+    "header_links_before_dropdown": 8,
+    "icon_links": [
+        {
+          "name": "GitHub",
+          "url": "https://github.com/pyfar",
+          "icon": "fa-brands fa-square-github",
+          "type": "fontawesome",
+        },
+    ],
+    # Configure secondary (right) side bar
+    "show_toc_level": 3,  # Show all subsections of notebooks
+    "secondary_sidebar_items": ["page-toc"],  # Omit 'show source' link that that shows notebook in json format
+    "navigation_with_keys": True,
+    # Configure navigation depth for section navigation
+    "navigation_depth": 1,
+}
+
+html_context = {
+   "default_mode": "light"
+}
+
+# redirect index to pyfar.html
+redirects = {
+     "index": "sparrowpy.html"
+}
+
+# -- download navbar and style files from gallery -----------------------------
+branch = 'main'
+link = f'https://github.com/pyfar/gallery/raw/{branch}/docs/'
+folders_in = [
+    '_static/css/custom.css',
+    '_static/favicon.ico',
+    '_static/header.rst',
+    'resources/logos/pyfar_logos_fixed_size_sparrowpy.png',
+    ]
+
+def download_files_from_gallery(link, folders_in):
+    c = urllib3.PoolManager()
+    for file in folders_in:
+        url = link + file
+        filename = file
+        os.makedirs(os.path.dirname(filename), exist_ok=True)
+        with c.request('GET', url, preload_content=False) as res:
+            if res.status == 200:
+                with open(filename, 'wb') as out_file:
+                    shutil.copyfileobj(res, out_file)
+
+download_files_from_gallery(link, folders_in)
+# if logo does not exist, use pyfar logo
+if not os.path.exists(html_logo):
+    download_files_from_gallery(
+        link, ['resources/logos/pyfar_logos_fixed_size_pyfar.png'])
+    shutil.copyfile(
+        'resources/logos/pyfar_logos_fixed_size_pyfar.png', html_logo)
+
+# replace sparrowpy hard link to internal link
+with open("_static/header.rst", "rt") as fin:
+    with open("header.rst", "wt") as fout:
+        lines = [line.replace(f'https://{project}.readthedocs.io', project) for line in fin]
+        contains_project = any(project in line for line in lines)
+
+        fout.writelines(lines)
+
+        # add project to the list of projects if not in header
+        if not contains_project:
+            fout.write(f'   {project} <{project}>\n')

docs/contributing.rst

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

docs/history.rst

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

docs/index.rst

@@ -0,0 +1,4 @@
+sparrowpy
+=========
+
+.. include:: header.rst

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=sparrowpy
+
+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

docs/modules/sparrowpy.brdf.rst

@@ -0,0 +1,7 @@
+sparrowpy.brdf
+==============
+
+.. automodule:: sparrowpy.brdf
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/sparrowpy.geometry.rst

@@ -0,0 +1,7 @@
+sparrowpy.geometry
+==================
+
+.. automodule:: sparrowpy.geometry
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/sparrowpy.radiosity.rst

@@ -0,0 +1,7 @@
+sparrowpy.radiosity
+===================
+
+.. automodule:: sparrowpy.radiosity
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/sparrowpy.sound_object.rst

@@ -0,0 +1,7 @@
+sparrowpy.sound_object
+======================
+
+.. automodule:: sparrowpy.sound_object
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/readme.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../README.md

docs/sparrowpy.rst

@@ -0,0 +1,69 @@
+sparrowpy
+=========
+
+.. toctree::
+   :maxdepth: 3
+   :hidden:
+
+   readme
+   api_reference
+   contributing
+   history
+
+
+Python Boilerplate contains all the boilerplate you need to create a Python package.
+
+.. grid:: 1 2 2 2
+    :gutter: 4
+
+    .. grid-item-card::
+        :link: readme.html
+        :text-align: center
+        :padding: 0 0 3 3
+
+        **Getting Started**
+        ^^^^
+
+        .. raw:: html
+
+            <i class="fa-solid fa-rocket icon-style"></i>
+
+
+    .. grid-item-card::
+        :link: api_reference
+        :link-type: ref
+        :text-align: center
+        :padding: 0 0 3 3
+
+        **API Reference**
+        ^^^^
+
+        .. raw:: html
+
+            <i class="fa-solid fa-file-lines icon-style"></i>
+
+
+    .. grid-item-card::
+        :link: contributing.html
+        :text-align: center
+        :padding: 0 0 3 3
+
+        **Contributing**
+        ^^^^
+
+        .. raw:: html
+
+            <i class="fa-solid fa-pen icon-style"></i>
+
+    .. grid-item-card::
+        :link: history.html
+        :text-align: center
+        :padding: 0 0 3 3
+
+        **History**
+        ^^^^
+
+        .. raw:: html
+
+            <i class="fa-solid fa-clock-rotate-left icon-style">
+            </i>

sparrowpy/__init__.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+
+"""Top-level package for sparrowpy."""
+
+__author__ = """The pyfar developers"""
+__email__ = ''
+__version__ = '0.1.0'
+
+
+from . import geometry
+from . import radiosity
+from . import sound_object
+from .radiosity_fast.radiosity_class import DirectionalRadiosityFast
+from .radiosity import (
+    RadiosityKang,
+    DirectionalRadiosityKang,
+    PatchesKang,
+    PatchesDirectionalKang)
+from . import testing
+from . import radiosity_fast
+from . import brdf
+from . import utils
+
+
+__all__ = [
+    'RadiosityKang',
+    'DirectionalRadiosityKang',
+    'PatchesKang',
+    'PatchesDirectionalKang',
+    'geometry',
+    'radiosity',
+    'sound_object',
+    'DirectionalRadiosityFast',
+    'radiosity_fast',
+    'testing',
+    'brdf',
+    'utils',
+]