sofar 1.1.4__tar.gz → 1.2.1__tar.gz

sofar-1.2.1/CONTRIBUTING.rst

@@ -0,0 +1,90 @@
+.. 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 sofar. 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/pyfar/sofar/issues.
+
+Fix Bugs or Implement Features
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Look through https://github.com/pyfar/sofar/issues for bugs or feature request
+and contact us or comment if you are interested in implementing.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+sofar could always use more documentation, whether as part of the
+official sofar 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 `sofar` 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 `sofar` repo on GitHub.
+2. Clone your fork locally and cd into the sofar directory::
+
+    $ git clone --recursive https://github.com/YOUR_USERNAME/sofar.git
+    $ cd sofar
+
+3. Note that some graphical Git interfaces can not do the recursive clone. If the folder sofar/sofa_conventions is empty try::
+
+    $ git submodule update --init
+    
+4. 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 sofar python
+    $ conda activate sofar
+    $ pip install -e ".[dev]"
+
+5. 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.
+
+6. 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 `./sofar` 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.
+
+7. 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
+
+8. Submit a pull request on the develop branch through the GitHub website.
+
+
+Submodules
+~~~~~~~~~~
+
+To update the submodule containing the conventions and verification rules run
+
+.. code-block:: bash
+
+    $ git submodule update --init --recursive
+    $ git submodule update --recursive --remote
+
+and then commit the changes
+
+.. _general contributing guidelines: https://pyfar-gallery.readthedocs.io/en/latest/contribute/index.html

{sofar-1.1.4 → sofar-1.2.1}/HISTORY.rst

@@ -1,6 +1,18 @@
+=======
 History
 =======
 
+1.2.1 (2024-12-12)
+------------------
+* Deployment: Move from setup.py to pyproject.toml (PR #114, #115)
+
+1.2.0 (2024-08-29)
+------------------
+* Feature: Introduce `SofaStream` class for reading parts of large Sofa files without reading the entire file (PR #90, 97)
+* Documentation: Add improved landing page for documentation on readthedocs.io and harmonize documentation (PR #80, 87, 88, 89, 92, 95, 96, 98, 101, 103, 105, 106, 107, 109)
+* Enhancement: When manually updating the conventions with `sofar.update_conventions`, the conventions are first downloaded to a temporary folder and compared to the existing conventions without overriding them (they were directly overridden before). The user is then informed about the changes and can continue or abort updating the conventions (PR #94)
+* Enhancement: Do not write `__Encoding` field for string variables, because it could cause issues with the Matlab SOFAtoolbox (PR #110)
+
 1.1.4 (2024-06-15)
 ------------------
 * Update for numpy 2.0 (PR #100)
@@ -81,4 +93,4 @@ History
 
 0.1.0 (2021-10-29)
 ------------------
-* First release on PyPI
+* First release on PyPI

{sofar-1.1.4 → sofar-1.2.1}/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) [2021] [The pyfar developers]
+MIT License
+
+Copyright (c) 2021, 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
@@ -17,3 +19,4 @@ 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.
+

{sofar-1.1.4 → sofar-1.2.1}/MANIFEST.in

@@ -1,8 +1,7 @@
-include AUTHORS.rst
 include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
-include README.rst
+include README.md
 
 include sofar/sofa_conventions/VERSION
 recursive-include sofar/sofa_conventions/conventions *.csv
@@ -10,3 +9,9 @@ recursive-include sofar/sofa_conventions/conventions *.json
 recursive-include sofar/sofa_conventions/conventions/deprecated *.csv
 recursive-include sofar/sofa_conventions/conventions/deprecated *.json
 recursive-include sofar/sofa_conventions/rules *.json
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

sofar-1.2.1/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.1
+Name: sofar
+Version: 1.2.1
+Summary: Maybe the most complete python package for SOFA files so far.
+Author-email: The pyfar developers <info@pyfar.org>
+License: MIT License
+        
+        Copyright (c) 2021, 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/pyfar/sofar/issues
+Project-URL: Documentation, https://sofar.readthedocs.io/
+Project-URL: Download, https://pypi.org/project/sofar/
+Project-URL: Homepage, https://pyfar.org/
+Project-URL: Source, https://github.com/pyfar/sofar
+Project-URL: Changelog, https://github.com/pyfar/sofar/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.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netCDF4
+Requires-Dist: numpy>=1.14.0
+Requires-Dist: beautifulsoup4
+Requires-Dist: requests
+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.8.2; extra == "tests"
+Requires-Dist: coverage; 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: sofar[deploy,docs,tests]; extra == "dev"
+
+<h1 align="center">
+<img src="https://github.com/pyfar/gallery/raw/main/docs/resources/logos/pyfar_logos_fixed_size_sofar.png" width="300">
+</h1><br>
+
+[![PyPI version](https://badge.fury.io/py/sofar.svg)](https://badge.fury.io/py/sofar)
+[![Documentation Status](https://readthedocs.org/projects/sofar/badge/?version=latest)](https://sofar.readthedocs.io/en/latest/?badge=latest)
+[![CircleCI](https://circleci.com/gh/pyfar/sofar.svg?style=shield)](https://circleci.com/gh/pyfar/sofar)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/sofar_introduction.ipynb)
+
+Sofar is maybe the most complete Python package for the SOFA file format so
+far. SOFA files store spatially distributed acoustic data such as impulse
+responses or transfer functions. They are defined by the AES69-2022 standard
+(see references). These are the key features of sofar
+
+- Read, edit, and write SOFA files
+- Add custom attributes to SOFA files
+- Full Verification of the content of a SOFA files against AES69-2022
+- Upgrade data that uses outdated SOFA conventions
+- Open license allows unrestricted use
+- sofar is tested using continuous integration on
+- Uses a complete definition of the AES69-2022 standard (see references) maintained at [sofa_conventions](https://github.com/pyfar/sofa_conventions)
+
+Getting Started
+===============
+
+The [sofar and SOFA notebook](https://pyfar-gallery.readthedocs.io/en/latest/gallery/interactive/sofar_introduction.html)
+gives an overview of the most important sofar functionality and is a good starting point. For processing and visualizing data
+inside SOFA files, we recommend the [pyfar package](https://pyfar.readthedocs.io) that can read SOFA files through
+`pyfar.io.read_sofa` and the in-depth examples contained in the
+[pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html). Check out
+[read the docs](https://sofar.readthedocs.io) for a complete documentation of sofar. A more detailed introduction to the SOFA
+file format is given by Majdak et. al. 2022 (see references below). All information is also bundled at [pyfar.org](https://pyfar.org).
+
+Installation
+============
+
+Use pip to install sofar
+
+    pip install sofar
+
+
+(Requires Python >= 3.8)
+
+If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
+
+Contributing
+============
+
+Refer to the [contribution guidelines](https://sofar.readthedocs.io/en/stable/contributing.html) for more information.
+
+References
+==========
+
+AES69-2022: *AES standard for file exchange - Spatial acoustic data file
+format*, Audio Engineering Society, Inc., New York, NY, USA.
+(https://www.aes.org/publications/standards/search.cfm?docID=99)
+
+P. Majdak, F. Zotter, F. Brinkmann, J. De Muynke, M. Mihocic, and M.
+Noisternig, "Spatially Oriented Format for Acoustics 2.1: Introduction and
+Recent Advances", *J. Audio Eng. Soc.*, vol. 70, no. 7/8, pp. 565-584,
+Jul. 2022. DOI: https://doi.org/10.17743/jaes.2022.0026

sofar-1.2.1/README.md

@@ -0,0 +1,61 @@
+<h1 align="center">
+<img src="https://github.com/pyfar/gallery/raw/main/docs/resources/logos/pyfar_logos_fixed_size_sofar.png" width="300">
+</h1><br>
+
+[![PyPI version](https://badge.fury.io/py/sofar.svg)](https://badge.fury.io/py/sofar)
+[![Documentation Status](https://readthedocs.org/projects/sofar/badge/?version=latest)](https://sofar.readthedocs.io/en/latest/?badge=latest)
+[![CircleCI](https://circleci.com/gh/pyfar/sofar.svg?style=shield)](https://circleci.com/gh/pyfar/sofar)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/sofar_introduction.ipynb)
+
+Sofar is maybe the most complete Python package for the SOFA file format so
+far. SOFA files store spatially distributed acoustic data such as impulse
+responses or transfer functions. They are defined by the AES69-2022 standard
+(see references). These are the key features of sofar
+
+- Read, edit, and write SOFA files
+- Add custom attributes to SOFA files
+- Full Verification of the content of a SOFA files against AES69-2022
+- Upgrade data that uses outdated SOFA conventions
+- Open license allows unrestricted use
+- sofar is tested using continuous integration on
+- Uses a complete definition of the AES69-2022 standard (see references) maintained at [sofa_conventions](https://github.com/pyfar/sofa_conventions)
+
+Getting Started
+===============
+
+The [sofar and SOFA notebook](https://pyfar-gallery.readthedocs.io/en/latest/gallery/interactive/sofar_introduction.html)
+gives an overview of the most important sofar functionality and is a good starting point. For processing and visualizing data
+inside SOFA files, we recommend the [pyfar package](https://pyfar.readthedocs.io) that can read SOFA files through
+`pyfar.io.read_sofa` and the in-depth examples contained in the
+[pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html). Check out
+[read the docs](https://sofar.readthedocs.io) for a complete documentation of sofar. A more detailed introduction to the SOFA
+file format is given by Majdak et. al. 2022 (see references below). All information is also bundled at [pyfar.org](https://pyfar.org).
+
+Installation
+============
+
+Use pip to install sofar
+
+    pip install sofar
+
+
+(Requires Python >= 3.8)
+
+If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
+
+Contributing
+============
+
+Refer to the [contribution guidelines](https://sofar.readthedocs.io/en/stable/contributing.html) for more information.
+
+References
+==========
+
+AES69-2022: *AES standard for file exchange - Spatial acoustic data file
+format*, Audio Engineering Society, Inc., New York, NY, USA.
+(https://www.aes.org/publications/standards/search.cfm?docID=99)
+
+P. Majdak, F. Zotter, F. Brinkmann, J. De Muynke, M. Mihocic, and M.
+Noisternig, "Spatially Oriented Format for Acoustics 2.1: Introduction and
+Recent Advances", *J. Audio Eng. Soc.*, vol. 70, no. 7/8, pp. 565-584,
+Jul. 2022. DOI: https://doi.org/10.17743/jaes.2022.0026

sofar-1.2.1/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    = sofar
+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)

sofar-1.2.1/docs/api_reference.rst

@@ -0,0 +1,20 @@
+.. _api_reference:
+
+API Reference
+=============
+
+This section documents sofar objects and functions. Sofar contains functions
+for reading, writing and comparing SOFA files, functions to handle SOFA
+conventions, and two classes to handle data from SOFA files. The
+:py:class:`~sofar.Sofa` class is used to read and write entire SOFA files. To
+open a SOFA file without reading the entire file into memory,
+:py:class:`~sofar.SofaStream` enables partially reading data.
+
+For examples on how to use sofar refer to the
+:ref:`sofar and SOFA <gallery:/gallery/interactive/sofar_introduction.ipynb>`
+notebook and the documentation below.
+
+.. automodule:: sofar
+   :members:
+   :undoc-members:
+   :show-inheritance:

sofar-1.2.1/docs/conf.py

@@ -0,0 +1,167 @@
+# 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 sofar
+import resources.conventions
+
+# -- 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',
+    'sphinx.ext.imgmath',
+    '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 = 'sofar'
+copyright = '2020, 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 = sofar.__version__
+# The full version, including alpha/beta/rc tags.
+release = sofar.__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),
+    'gallery': ('https://pyfar-gallery.readthedocs.io/en/latest/', 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_sofar.png'
+html_title = "sofar"
+html_favicon = '_static/favicon.ico'
+
+# -- HTML theme options
+# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html
+html_sidebars = {
+  "sofar": []
+}
+
+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": f"{project}.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_sofar.png',
+    ]
+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, open(filename, 'wb') as out_file:
+        shutil.copyfileobj(res, out_file)
+
+# replace sofar hard link to internal link
+with open("_static/header.rst", "rt") as fin:
+    with open("header.rst", "wt") as fout:
+        for line in fin:
+            fout.write(line.replace(f'https://{project}.readthedocs.io', project))

sofar-1.2.1/docs/contributing.rst

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

sofar-1.2.1/docs/history.rst

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

sofar-1.2.1/docs/index.rst

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

sofar-1.2.1/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=sofar
+
+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

sofar-1.2.1/docs/readme.rst

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