diff --git a/README.md b/README.md index 5cf58b3c21b015c09509f015aad27acf9da229d0..d050cc6ad53972a7c93ec81df333842e54648493 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,62 @@ -Copyright (c) 2025 Huawei Technologies Co., Ltd. All rights - reserved. -# Open MPI - -[The Open MPI Project](https://www.open-mpi.org/) is an open source -implementation of the [Message Passing Interface (MPI) -specification](https://www.mpi-forum.org/docs/) that is developed and -maintained by a consortium of academic, research, and industry -partners. Open MPI is therefore able to combine the expertise, -technologies, and resources from all across the High Performance -Computing community in order to build the best MPI library available. -Open MPI offers advantages for system and software vendors, -application developers and computer science researchers. - -## Official documentation - -The Open MPI documentation can be viewed in the following ways: - -1. Online at https://docs.open-mpi.org/ -1. In self-contained (i.e., suitable for local viewing, without an - internet connection) in official distribution tarballs under - `docs/_build/html/index.html`. - -## Building the documentation locally - -The source code for Open MPI's docs can be found in the Open MPI Git -repository under the `docs` folder. - -Developers who clone the Open MPI Git repository will not have the -HTML documentation and man pages by default; it must be built. -Instructions for how to build the Open MPI documentation can be found -here: -https://docs.open-mpi.org/en/v5.0.x/developers/prerequisites.html#sphinx. +# kmpi + +#### 介绍 + +kmpi is a message passing library for HPC. + +#### 软件架构 + +1. Open Portability Access Layer(OPAL): 底层的,适配不同操作系统并且架构代码可移植 +2. Open MPI(OMPI): 唯一暴露给用户的层,MPI操作语义相关定义在此层,与上层关联最紧密 +3. OpenSHMEM(OSHMEM): 提供OpenSHMEM接口 + +OpenMPI使用MCA(Modular Component Architecture)结构来构建软件,MCA主要包含框架(Frameworks)、组件(Components)和模块(Modules),每一层都使用MCA方式来构建,MCA方式允许用户添加自己的自定义实现库。 + 框架(framework): 管理多个组件,允许使用管理不同组件来实现特定功能,提供统一接口。 + 组件(components): framework框架接口的具体实现,不同的组件可以独立的加载使用 + 模块(modules): 组件的一个实例 +#### 安装教程 + +1. shell$ git clone https://gitee.com/openeuler/kmpi.git +2. shell$ ./configure --prefix= [...options...] 2>&1 | tee config.out +3. shell$ make[-j N] all 2>&1 | tee make.out +4. shell$ make install 2>&1 | tee install.out + +#### 使用说明 + +mpirun [-n X] [--hostfile ] + +X: run X copies of in your current run-time environment +ssh, which require the use of a hostfile + +#### 社区安全问题求助渠道 + +https://gitee.com/openeuler/kmpi/issues + +#### 官网漏洞披露地址 + +https://github.com/open-mpi/ompi/security/advisories + +#### 参与贡献 + +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request + +如有任何问题请联系:liujianguo14@huawei.com + +#### 贡献者 + +zhujia +liu-jianguo2024 +zhulin11 +luzhexuan + +#### 特技 + +1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md +2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) +3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 +4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 +5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) +6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)