sparrowpy 0.1.0__tar.gz

sparrowpy-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,74 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given. The following helps you to start
+contributing specifically to sparrowpy. Please also consider the
+`general contributing guidelines`_ for example regarding the style
+of code and documentation and some helpful hints.
+
+Types of Contributions
+----------------------
+
+Report Bugs or Suggest Features
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The best place for this is https://github.com/ahms5/sparrowpy/issues.
+
+Fix Bugs or Implement Features
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Look through https://github.com/ahms5/sparrowpy/issues for bugs or feature request
+and contact us or comment if you are interested in implementing.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+sparrowpy could always use more documentation, whether as part of the
+official sparrowpy docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `sparrowpy` for local development using the command-line interface. Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop <https://desktop.github.com/>`_, extensions in `Visual Studio Code <https://code.visualstudio.com/>`_ ...
+
+1. `Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo/>`_ the `sparrowpy` repo on GitHub.
+2. Clone your fork locally and cd into the sparrowpy directory::
+
+    $ git clone https://github.com/YOUR_USERNAME/sparrowpy.git
+    $ cd sparrowpy
+
+3. Install your local copy into a virtualenv. Assuming you have Anaconda or Miniconda installed, this is how you set up your fork for local development::
+
+    $ conda create --name sparrowpy python=3.11
+    $ conda activate sparrowpy
+    $ pip install -e ".[dev]"
+
+4. Create a branch for local development. Indicate the intention of your branch in its respective name (i.e. `feature/branch-name` or `bugfix/branch-name`)::
+
+    $ 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 ruff and the
+   tests::
+
+    $ ruff check
+    $ pytest
+
+   ruff must pass without any warnings for `./sparrowpy` and `./tests` using the default or a stricter configuration. Ruff ignores a couple of PEP Errors (see `./pyproject.toml`). If necessary, adjust your linting configuration in your IDE accordingly.
+
+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 on the develop branch through the GitHub website.
+
+
+.. _general contributing guidelines: https://pyfar-gallery.readthedocs.io/en/latest/contribute/index.html

sparrowpy-0.1.0/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2025-03-18)
+------------------
+
+* First release on PyPI.

sparrowpy-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, The pyfar developers
+
+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.
+

sparrowpy-0.1.0/MANIFEST.in

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

sparrowpy-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.2
+Name: sparrowpy
+Version: 0.1.0
+Summary: Project for data formats in acoustics.
+Author-email: The pyfar developers <info@pyfar.org>
+License: MIT License
+        
+        Copyright (c) 2024, The pyfar developers
+        
+        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.
+        
+        
+Project-URL: Tracker, https://github.com/ahms5/sparrowpy/issues
+Project-URL: Documentation, https://sparrowpy.readthedocs.io/
+Project-URL: Download, https://pypi.org/project/sparrowpy/
+Project-URL: Homepage, https://pyfar.org/
+Project-URL: Source, https://github.com/ahms5/sparrowpy
+Project-URL: Changelog, https://github.com/ahms5/sparrowpy/blob/main/HISTORY.rst
+Keywords: acoustics,pyfar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: pyfar
+Requires-Dist: sofar
+Provides-Extra: blender
+Requires-Dist: bpy; extra == "blender"
+Provides-Extra: fast
+Requires-Dist: numba; extra == "fast"
+Provides-Extra: progress
+Requires-Dist: tqdm; extra == "progress"
+Provides-Extra: deploy
+Requires-Dist: twine; extra == "deploy"
+Requires-Dist: wheel; extra == "deploy"
+Requires-Dist: build; extra == "deploy"
+Requires-Dist: setuptools; extra == "deploy"
+Requires-Dist: bump-my-version; extra == "deploy"
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: watchdog; extra == "tests"
+Requires-Dist: ruff==0.9.*; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Requires-Dist: watermark; extra == "tests"
+Requires-Dist: ipykernel; extra == "tests"
+Requires-Dist: sparrowpy[fast]; extra == "tests"
+Requires-Dist: sparrowpy[blender]; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: autodocsumm>=0.2.14; extra == "docs"
+Requires-Dist: pydata-sphinx-theme; extra == "docs"
+Requires-Dist: sphinx_mdinclude; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-favicon; extra == "docs"
+Requires-Dist: sphinx-reredirects; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: sparrowpy[deploy,docs,tests]; extra == "dev"
+
+<h1 align="center">
+<img src="https://github.com/sparrow-acoustics/sparrowpy/raw/main/docs/_static/logo.png" width="300">
+</h1><br>
+
+
+[![PyPI version](https://badge.fury.io/py/sparrowpy.svg)](https://badge.fury.io/py/sparrowpy)
+[![Documentation Status](https://readthedocs.org/projects/sparrowpy/badge/?version=latest)](https://sparrowpy.readthedocs.io/en/latest/?badge=latest)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
+Python Boilerplate contains all the boilerplate you need to create a Python package.
+
+Getting Started
+===============
+
+The [pyfar workshop](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
+gives an overview of the most important pyfar functionality and is a good
+starting point. It is part of the [pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html)
+that also contains more specific and in-depth
+examples that can be executed interactively without a local installation by
+clicking the mybinder.org button on the respective example. The
+[pyfar documentation](https://pyfar.readthedocs.io) gives a detailed and complete overview of pyfar. All
+these information are available from [pyfar.org](https://pyfar.org).
+
+Installation
+============
+
+Use pip to install sparrowpy
+
+    pip install sparrowpy
+
+(Requires Python >= 3.9)
+
+if numba is installed the code will be precompiled and will run faster. We strongly recommend to use numba to accelerate the simulations significantly
+
+    pip install sparrowpy[fast]
+
+or
+
+    pip install sparrowpy
+    pip install numba
+
+you can also use blender for geometry import. Note that blender has strong requirements on the python version, see [pypi](https://pypi.org/project/bpy/). You can install it via pip
+
+    pip install bpy
+
+to show progress bars install tqdm
+
+    pip install tqdm
+
+by default these packages are not installed
+
+Audio file reading/writing is supported through [SoundFile](https://python-soundfile.readthedocs.io), which is based on
+[libsndfile](http://www.mega-nerd.com/libsndfile/). On Windows and OS X, it will be installed automatically.
+On Linux, you need to install libsndfile using your distribution’s package manager, for example ``sudo apt-get install libsndfile1``.
+If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
+
+Contributing
+============
+
+Check out the [contributing guidelines](https://pyfar.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.

sparrowpy-0.1.0/README.md

@@ -0,0 +1,59 @@
+<h1 align="center">
+<img src="https://github.com/sparrow-acoustics/sparrowpy/raw/main/docs/_static/logo.png" width="300">
+</h1><br>
+
+
+[![PyPI version](https://badge.fury.io/py/sparrowpy.svg)](https://badge.fury.io/py/sparrowpy)
+[![Documentation Status](https://readthedocs.org/projects/sparrowpy/badge/?version=latest)](https://sparrowpy.readthedocs.io/en/latest/?badge=latest)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
+Python Boilerplate contains all the boilerplate you need to create a Python package.
+
+Getting Started
+===============
+
+The [pyfar workshop](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
+gives an overview of the most important pyfar functionality and is a good
+starting point. It is part of the [pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html)
+that also contains more specific and in-depth
+examples that can be executed interactively without a local installation by
+clicking the mybinder.org button on the respective example. The
+[pyfar documentation](https://pyfar.readthedocs.io) gives a detailed and complete overview of pyfar. All
+these information are available from [pyfar.org](https://pyfar.org).
+
+Installation
+============
+
+Use pip to install sparrowpy
+
+    pip install sparrowpy
+
+(Requires Python >= 3.9)
+
+if numba is installed the code will be precompiled and will run faster. We strongly recommend to use numba to accelerate the simulations significantly
+
+    pip install sparrowpy[fast]
+
+or
+
+    pip install sparrowpy
+    pip install numba
+
+you can also use blender for geometry import. Note that blender has strong requirements on the python version, see [pypi](https://pypi.org/project/bpy/). You can install it via pip
+
+    pip install bpy
+
+to show progress bars install tqdm
+
+    pip install tqdm
+
+by default these packages are not installed
+
+Audio file reading/writing is supported through [SoundFile](https://python-soundfile.readthedocs.io), which is based on
+[libsndfile](http://www.mega-nerd.com/libsndfile/). On Windows and OS X, it will be installed automatically.
+On Linux, you need to install libsndfile using your distribution’s package manager, for example ``sudo apt-get install libsndfile1``.
+If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
+
+Contributing
+============
+
+Check out the [contributing guidelines](https://pyfar.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.

sparrowpy-0.1.0/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)

sparrowpy-0.1.0/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

sparrowpy-0.1.0/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')

sparrowpy-0.1.0/docs/contributing.rst

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

sparrowpy-0.1.0/docs/history.rst

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

sparrowpy-0.1.0/docs/index.rst

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

sparrowpy-0.1.0/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

sparrowpy-0.1.0/docs/modules/sparrowpy.brdf.rst

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

sparrowpy-0.1.0/docs/modules/sparrowpy.geometry.rst

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

sparrowpy-0.1.0/docs/modules/sparrowpy.radiosity.rst

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

sparrowpy-0.1.0/docs/modules/sparrowpy.sound_object.rst

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

sparrowpy-0.1.0/docs/readme.rst

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