BROmodels

GEOTOP和REGIS数据是从DINOloket OPeNDAP服务器下载的。

有关GEOTOP或REGIS的更多信息

• https://www.dinoloket.nl/en/search-and-request-geotop
• https://www.dinoloket.nl/en/regis-ii-hydrogeological-model
• http://dinodata.nl/opendap/

请注意，必须有一个活动的互联网连接！

安装

要安装此包，请运行

pip install bromodels

贡献

环境

我们建议使用Python3.9和一个干净的虚拟环境（使用virtualenv或conda）进行开发，从requirements.txt文件安装需求

使用virtualenv和pip在Linux上安装依赖项的新环境.env的示例

python -m venv .env
source activate .env/bin/activate
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .

文档

构建文档

python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install .
sphinx-build -b html docs public

格式

我们使用black和isort格式化我们的代码。

black --config "pyproject.toml" src tests examples docs
isort --settings-path "pyproject.toml" src tests examples docs

代码审查

为了保持代码质量，我们使用GitHub super-linter。

要本地运行代码审查器，从根目录运行run_super_linters.sh bash脚本。

单元测试

使用覆盖率测试软件

python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install .
coverage run -m pytest

需求

需求由python 3.9的pip-compile自动生成

pip-compile --extra=test --extra=docs --extra=lint --extra=3d --output-file=requirements.txt pyproject.toml

要更新定义范围内的需求，请运行

pip-compile --upgrade --extra=test --extra=docs --extra=lint --extra=3d --output-file=requirements.txt pyproject.toml