plxcontroller

控制器用于创建和修改带有增强功能的Plaxis 2D和3D模型。

此仓库由 CEMS BV 创建。

安装

要安装此仓库中的包，请运行

$ pip install plxcontroller

贡献

环境

我们建议在Python3.9中开发，使用干净的虚拟环境（使用virtualenv或conda），从requirements.txt文件安装要求

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

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

格式

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

black --config "pyproject.toml" src/plxcontroller tests notebooks
isort --settings-path "pyproject.toml" src/plxcontroller tests notebooks

代码检查

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

要本地运行代码检查，请从根目录运行run_super_linter.sh bash脚本。

单元测试

使用覆盖率测试软件

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

要求

要求由python 3.9的pip-compile命令自动生成

使用以下命令安装pip-tools

pip install pip-tools

使用以下命令生成requirements.txt文件

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

使用以下命令在定义的范围内更新要求

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