delft3dfmpy的顶级包。
delft3dfmp的Python项目详细描述
Python包从标准化数据模型或其他流模型生成delft3dfm模型。在
- 免费软件:麻省理工学院许可证
- 文档:https://dhydamo.readthedocs.io。在
- 维基(荷兰语):https://hkvconfluence.atlassian.net/wiki/spaces/DHYD/pages/222396421/Achtergrond
特点
- 将Hydamo或shape文件读取到Python数据结构
- 从Hydamo或单独定义的元素构建Delft3D FM模型
- 优化生成矩形网格
- 创建1D 2D连接
- 创建RR模型方案
- 写入Delft3D FM模型
安装
包delft3dfmpy要求您具有(a)具有所需依赖项的环境和(b)可以访问此环境的集成开发环境(IDE)。在
在安装Python包delft3dfmpy之前,请先满足这两个条件并使用下面的说明。在
Python包delft3dfmpy
通过在Anaconda提示符中执行以下命令,直接安装Python包delft3dfmpy
在^{tt5}$
如果命令提示符显示Successfully built delft3dfmpy,则安装成功。在
在
环境准备
为delft3dfmpy准备一个具有正确依赖关系的环境。在
安装Anaconda或Minoconda Python发行版:
在https://www.anaconda.com/products/individualhttps://docs.conda.io/en/latest/miniconda.html
保存https://raw.githubusercontent.com/openearth/delft3dfmpy/master/environment.yml的内容,并将其存储在名为environment.yml的本地文件中
在打开Ananconda提示符并输入存储步骤2中的envrionment.yml的目录。在
在通过在打开的命令提示符中执行以下命令,安装带有所需模块的delft3dfmpy环境。在
^{tt11}$
这将创建一个具有所需依赖项的delft3dfmpy环境。在
在通过命令提示符中的以下命令激活创建的环境:
^{tt13}$
现在您有了一个正确且激活的环境来安装delft3dfmpyPython包
在
IDE中的环境集成
准备好的环境的集成依赖于使用的IDE。在这里,我们简要地提到了用户的一些选项(请选择一个!)公司名称:
对于激活环境中的Jupyter新实例:
在Using Notebook
^{tt15}$
or using JupyterLab
^{tt16}$
要将新创建的环境注册为Jupyter(笔记本或JupyterLab)的新内核:
在^{tt17}$
PyCharm、Spyder或VSCode+Python扩展不需要额外的操作。在
在
使用
在运行笔记本或脚本之前,在(Anaconda)命令提示符(conda activate delft3dfmpy)中激活创建的环境。环境的Jupyter笔记本或命令提示符也可以从Anaconda Navigator启动。 有关如何使用环境的详细信息,请参阅:https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
这个用法最好用示例笔记本来描述:https://github.com/openearth/delft3dfmpy/blob/master/notebooks/Usage_introduction_coupled_RRFM.ipynb
贡献
对于文档、需要的特性和bug,我们非常欢迎您的贡献。代码和开发在GitHub存储库中进行:https://github.com/openearth/delft3dfmpy。在
对于捐款,请使用以下准则:
在GitHub上派生项目并将Fork克隆到您的操作系统。在
在请确保已按照上述说明安装并激活了环境。在
在Delft3dfmpy使用flit来构建、打包和发布项目。要安装开发依赖项并将克隆的fork注册为Python包以用于开发,请执行以下操作:
在From an elevated Anaconda Prompt (run as Administrator) within the activated ^{tt1}$ environment:
^{tt21}$
^{tt22}$
This installs the development dependencies and creates a symbolic link in the Python site-packages folder of the activated environment.
在您最喜欢的IDE中以文件夹/工作区的形式打开存储库(例如VSCode+Python扩展)
在做出贡献并在本地测试更改。在
在一旦得到满足,将更改作为一个新分支推送到fork,并对原始repo创建一个Pull请求伊托里。在
在GitHub主存储库的维护人员将检查您的PR并指导合并过程。在
在
- 项目
标签: