Skip to content

Commit

Permalink
Merge pull request #129 from csdms/mdpiper/add-council-members
Browse files Browse the repository at this point in the history
Add council members
  • Loading branch information
mdpiper authored Aug 31, 2023
2 parents fa003e0 + fa64919 commit e7c830f
Show file tree
Hide file tree
Showing 21 changed files with 413 additions and 141 deletions.
5 changes: 5 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[flake8]
ignore = C901, E203, E266, E501, W503, B905
max-line-length = 88
max-complexity = 18
select = B,C,E,F,W,T4,B9
3 changes: 3 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Migrate code style to Black
6dcff756be4bb836fcb3845fdc5fc78e678a9db8
3a887ce1521f96f8499d3531d5b52c1ad7af14d1
5 changes: 4 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
if:
github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
github.repository

runs-on: ubuntu-latest

steps:
Expand All @@ -36,5 +36,8 @@ jobs:
- name: Install dependencies
run: pip install nox

- name: Check for lint
run: nox -s lint

- name: Build documentation
run: nox -s build-docs
135 changes: 135 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# DS_Store
*.DS_Store

# backup files
*.bak
48 changes: 48 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
repos:
- repo: https://github.com/psf/black
rev: 23.1.0
hooks:
- id: black
name: black
description: "Black: The uncompromising Python code formatter"
entry: black
language: python
language_version: python3
minimum_pre_commit_version: 2.9.2
require_serial: true
types_or: [python, pyi]

- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
- id: flake8
additional_dependencies:
- flake8-bugbear
- flake8-comprehensions
- flake8-simplify

- repo: https://github.com/asottile/pyupgrade
rev: v3.3.1
hooks:
- id: pyupgrade
args: [--py39-plus]

- repo: https://github.com/PyCQA/isort
rev: 5.12.0
hooks:
- id: isort
files: \.py$

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: check-builtin-literals
- id: check-added-large-files
- id: check-case-conflict
- id: check-toml
- id: check-yaml
- id: debug-statements
- id: end-of-file-fixer
- id: forbid-new-submodules
- id: mixed-line-ending
- id: trailing-whitespace
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ 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.
SOFTWARE.
2 changes: 1 addition & 1 deletion docs/source/bmi.best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ here are some tips to help when writing a BMI for a model.
standardized names makes it easier for a framework (or a human) to
match input and output variables between models.

* Don't change the variable names for exchange items
* Don't change the variable names for exchange items
you currently use within your model
to :term:`Standard Names`. Instead, find a
`matching`_ Standard Name for each variable and then
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bmi.getter_setter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ so getters are called to get current values.

A *setter* is a function called to change/overwrite a variable in
a model's state. A setter may impose restrictions on how a
state variable can be changed or check the new data for validity.
state variable can be changed or check the new data for validity.


.. _get_value:
Expand Down
6 changes: 3 additions & 3 deletions docs/source/bmi.grid_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Model grid functions
--------------------

The functions in this section describe :ref:`model grids <model_grids>`.
The functions in this section describe :ref:`model grids <model_grids>`.
In the BMI,
every :term:`exchange item` is defined on a grid,
and is referenced by a :term:`grid identifier`
Expand Down Expand Up @@ -395,7 +395,7 @@ Get the number of :term:`faces <face>` in the grid.
Get the edge-node connectivity.

For each edge, connectivity is given as node at edge tail, followed by
node at edge head. The total length of the array is
node at edge head. The total length of the array is
2 * :ref:`get_grid_edge_count`.

**Implementation notes**
Expand Down Expand Up @@ -451,7 +451,7 @@ Get the face-node connectivity.

For each face, the nodes (listed in a counter-clockwise direction)
that form the boundary of the face.
For a grid of quadrilaterals,
For a grid of quadrilaterals,
the total length of the array is 4 * :ref:`get_grid_face_count`.
More generally,
the length of the array is the sum of the values of
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bmi.info_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Model information functions
---------------------------

These functions supply the model name
and the model's :term:`exchange items <exchange item>` --
and the model's :term:`exchange items <exchange item>` --
the variables that the model can use from
and provide to other models that have a BMI.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bmi.spec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ grouped by functional category.
:widths: 30, 70

============================== =========================================
Function Description
Function Description
============================== =========================================
:ref:`initialize` Perform startup tasks for the model.
:ref:`update` Advance model state by one time step.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bmi.var_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ These BMI functions provide information
about a particular input or output variable.
They must accommodate any variable returned from the
:ref:`get_input_var_names` or :ref:`get_output_var_names` functions --
the variable name is used as an argument in each function.
the variable name is used as an argument in each function.
Based on the information returned,
type or unit conversions can be applied when necessary.

Expand Down
Loading

0 comments on commit e7c830f

Please sign in to comment.