csdms / bmi-example-python Goto Github PK

According to the BMI spec, the filename argument for the BMI initialize method must not be optional and must be a string. Right now BmiHeat.initialize accepts either None, a file-like object, or a string. I think this should be changed so that it only accepts a string that is a path to a configuration file.

i.e.

def initialize(self, filename: str):
    with open(filename) as file_obj:
        self._model = Heat.from_file_like(file_obj)
    ...

Actually, in looking at what's there now, I think there's also a bug. Heat.from_file_like must take a stream, not a string

i.e.

Heat.from_file_like(file_obj.read())

should be

Heat.from_file_like(file_obj)

Should we expand the set of requirements files for this repository? I'm thinking about four separate files.

requirements.txt -- packages needed to install with pip install -e .

• numpy
• scipy
• pyyaml
• bmipy

requirements-dev.txt -- developer packages used with the repo Makefile

• make
• build
• twine
• flake8
• black
• isort

requirements-testing.txt -- packages used for running tests

• coveralls
• pytest
• pytest-cov
• six
• bmi-tester

requirements-examples.txt -- packages used for running examples

• notebook

Versioneer is sunsetting and zest.releaser is the recommended replacement.

This is a legacy folder that should be removed. All BMI docs are built from the main BMI repository.

Also remove docs badge from README.

Apparently this was an alias, and it was recently removed. See scipy/scipy#14889.

This import is only used once, in the heat.py module.

In this example, the current set_value implementation is:

A problem arises when the model variable referenced by get_value_ptr is dimensional--the input src argument is flattened, by definition, while the val variable is dimensional. This raises an exception with a message like

ValueError: could not broadcast input array from shape (48,) into shape (8,6)