GeoProfile

使用GeoProfile探索地球深处，这是一个专为岩土工程师和研究人员设计的全面软件包。这个多功能的工具包是您分析和可视化岩土工程剖面的首选资源，为理解地下复杂地层结构提供无缝体验。

无论您是从事土木工程、环境科学还是岩土勘探，GeoProfile都是您不可或缺的伴侣，以揭开地表下的奥秘。借助GeoProfile，提升您的岩土工程分析能力，做出明智的决策——地质与技术的交汇点。

安装

要安装此软件包，包括map和gef读取功能，请运行

pip install geoprofile[map, gef]

如果不需要GeoProfile库（例如，仅使用纯绘图），请运行以跳过安装

pip install geoprofile

贡献

环境

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

使用virtualenv和pip在Linux上安装依赖关系的示例

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

注意：您需要设置NUCLEI_TOKEN环境变量。您可以在：https://cemsbv.crux-nuclei.com获取您的令牌。

格式

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

black --config "pyproject.toml" src/geoprofile tests notebook docs
isort --settings-path "pyproject.toml" src/geoprofile tests notebook docs

代码检查

为了保持代码质量，我们使用GitHub超级代码检查器。

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

单元测试

使用coverage测试软件

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=map --extra=gef --output-file=requirements.txt pyproject.toml

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

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