+
diff --git a/docs/source/_templates/sidebarintro.html b/docs/source/_templates/sidebarintro.html
new file mode 100644
index 0000000..f09d068
--- /dev/null
+++ b/docs/source/_templates/sidebarintro.html
@@ -0,0 +1,4 @@
+
About bmipy
+
+ Python bindings for the Basic Model Interface.
+
diff --git a/docs/source/bmipy.rst b/docs/source/bmipy.rst
new file mode 100644
index 0000000..57aec98
--- /dev/null
+++ b/docs/source/bmipy.rst
@@ -0,0 +1,22 @@
+bmipy package
+=============
+
+Submodules
+----------
+
+bmipy.bmi module
+----------------
+
+.. automodule:: bmipy.bmi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: bmipy
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..fbe0538
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,170 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'bmipy'
+copyright = '2019, Eric Hutton'
+author = 'Eric Hutton'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.githubpages',
+ 'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# " v documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = "_static/powered-by-logo-header.png"
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+ "index": [
+ "sidebarintro.html",
+ "links.html",
+ "sourcelink.html",
+ "searchbox.html",
+ ],
+ "**": [
+ "sidebarintro.html",
+ "links.html",
+ "sourcelink.html",
+ "searchbox.html",
+ ]
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'bmidoc'
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
diff --git a/docs/source/environment.yml b/docs/source/environment.yml
new file mode 100644
index 0000000..6c4e7d4
--- /dev/null
+++ b/docs/source/environment.yml
@@ -0,0 +1,13 @@
+name: bmipy_docs
+channels:
+ - conda-forge
+dependencies:
+- python==3.6
+- pandoc
+- pip
+- sphinx>=1.5.1
+- sphinx_rtd_theme
+- tornado
+- entrypoints
+- pip:
+ - sphinxcontrib_github_alt
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..7346d0f
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,11 @@
+.. title:: BMIpy
+
+.. include:: ../../README.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
new file mode 100644
index 0000000..8f50db5
--- /dev/null
+++ b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+bmipy
+=====
+
+.. toctree::
+ :maxdepth: 4
+
+ bmipy
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..84678f7
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,4 @@
+coveralls
+flake8
+pytest>=3.6
+pytest-cov
diff --git a/setup.cfg b/setup.cfg
index 37bfd26..58ff3b5 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -2,29 +2,25 @@
disable = line-too-long,bad-continuation
[flake8]
-exclude = docs
-ignore =
- E203
- E501
- W503
+exclude = docs bmipy/_version.py
max-line-length = 88
[versioneer]
VCS = git
style = pep440
-versionfile_source = bmi/_version.py
-versionfile_build = bmi/_version.py
+versionfile_source = bmipy/_version.py
+versionfile_build = bmipy/_version.py
tag_prefix =
-parentdir_prefix = bmi-
+parentdir_prefix = bmipy-
[tool:pytest]
minversion = 3.0
-testpaths = bmi tests
+testpaths = bmipy tests
norecursedirs = .* *.egg* build dist
addopts =
--ignore setup.py
--ignore versioneer.py
- --ignore bmi/_version.py
+ --ignore bmipy/_version.py
--tb native
--strict
--durations 16
@@ -35,4 +31,4 @@ doctest_optionflags =
ALLOW_UNICODE
[run]
-omit = bmi/_version.py
+omit = bmipy/_version.py
diff --git a/tests/test_bmipy.py b/tests/test_bmipy.py
new file mode 100644
index 0000000..9527458
--- /dev/null
+++ b/tests/test_bmipy.py
@@ -0,0 +1,134 @@
+import pytest
+
+from bmipy import Bmi
+
+
+class EmptyBmi(Bmi):
+ def __init__(self):
+ pass
+
+ def initialize(self, config_file):
+ pass
+
+ def update(self):
+ pass
+
+ def update_until(self, then):
+ pass
+
+ def finalize(self):
+ pass
+
+ def get_var_type(self, var_name):
+ pass
+
+ def get_var_units(self, var_name):
+ pass
+
+ def get_var_nbytes(self, var_name):
+ pass
+
+ def get_var_itemsize(self, name):
+ pass
+
+ def get_var_location(self, name):
+ pass
+
+ def get_var_grid(self, var_name):
+ pass
+
+ def get_grid_rank(self, grid_id):
+ pass
+
+ def get_grid_size(self, grid_id):
+ pass
+
+ def get_value_ptr(self, var_name):
+ pass
+
+ def get_value(self, var_name):
+ pass
+
+ def get_value_at_indices(self, var_name, indices):
+ pass
+
+ def set_value(self, var_name, src):
+ pass
+
+ def set_value_at_indices(self, var_name, src, indices):
+ pass
+
+ def get_component_name(self):
+ pass
+
+ def get_input_var_names(self):
+ pass
+
+ def get_output_var_names(self):
+ pass
+
+ def get_grid_shape(self, grid_id):
+ pass
+
+ def get_grid_spacing(self, grid_id):
+ pass
+
+ def get_grid_origin(self, grid_id):
+ pass
+
+ def get_grid_type(self, grid_id):
+ pass
+
+ def get_start_time(self):
+ pass
+
+ def get_end_time(self):
+ pass
+
+ def get_current_time(self):
+ pass
+
+ def get_time_step(self):
+ pass
+
+ def get_time_units(self):
+ pass
+
+ def get_grid_edge_count(self, grid):
+ pass
+
+ def get_grid_edge_nodes(self, grid, edge_nodes):
+ pass
+
+ def get_grid_face_count(self, grid):
+ pass
+
+ def get_grid_face_nodes(self, grid, face_nodes):
+ pass
+
+ def get_grid_node_count(self, grid):
+ pass
+
+ def get_grid_nodes_per_face(self, grid, nodes_per_face):
+ pass
+
+ def get_grid_x(self, grid, x):
+ pass
+
+ def get_grid_y(self, grid, y):
+ pass
+
+ def get_grid_z(self, grid, z):
+ pass
+
+
+def test_bmi_not_implemented():
+ class MyBmi(Bmi):
+ pass
+
+ with pytest.raises(TypeError):
+ Bmi()
+
+
+def test_bmi_implemented():
+ assert isinstance(EmptyBmi(), Bmi)