Skip to content

Commit d47e43d

Browse files
njzjzcaic99
andcommitted
docs: add deprecation notice for the official conda channel and more conda docs (deepmodeling#3462)
Signed-off-by: Jinzhe Zeng <[email protected]> Co-authored-by: Chun Cai <[email protected]> (cherry picked from commit 80b6900) Signed-off-by: Jinzhe Zeng <[email protected]>
1 parent 6cc02ad commit d47e43d

File tree

3 files changed

+38
-16
lines changed

3 files changed

+38
-16
lines changed

doc/install/build-conda.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Building conda packages
22

3+
::::{danger}
4+
:::{deprecated} 3.0.0
5+
The official channel will be deprecated since 3.0.0.
6+
Refer to [conda-forge documentation](https://conda-forge.org/docs/maintainer/adding_pkgs/) for how to contribute and build packages locally.
7+
:::
8+
::::
9+
310
One may want to keep both convenience and personalization of the DeePMD-kit. To achieve this goal, one can consider building conda packages. We provide building scripts in [deepmd-kit-recipes organization](https://github.com/deepmd-kit-recipes/). These building tools are driven by [conda-build](https://github.com/conda/conda-build) and [conda-smithy](https://github.com/conda-forge/conda-smithy).
411

512
For example, if one wants to turn on `MPIIO` package in LAMMPS, go to [`lammps-feedstock`](https://github.com/deepmd-kit-recipes/lammps-feedstock/) repository and modify `recipe/build.sh`. `-D PKG_MPIIO=OFF` should be changed to `-D PKG_MPIIO=ON`. Then go to the main directory and execute

doc/install/easy-install-dev.md

+5
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,8 @@ The [pre-comiled C library](./install-from-c-library.md) can be downloaded from
3131
```sh
3232
wget https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/devel/libdeepmd_c-0-libdeepmd_c.tar.gz.zip && unzip libdeepmd_c-0-libdeepmd_c.tar.gz.zip
3333
```
34+
35+
## Pre-release conda-forge packages
36+
37+
Pre-release conda-forge packages are in `conda-forge/label/deepmd-kit_dev` or `conda-forge/label/deepmd-kit_rc` channels, other than the `conda-forge` channel.
38+
See [conda-forge documentation](https://conda-forge.org/docs/maintainer/knowledge_base/#pre-release-builds) for more information.

doc/install/easy-install.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ After your easy installation, DeePMD-kit (`dp`) and LAMMPS (`lmp`) will be avail
66

77
:::{note}
88
Note: The off-line packages and conda packages require the [GNU C Library](https://www.gnu.org/software/libc/) 2.17 or above. The GPU version requires [compatible NVIDIA driver](https://docs.nvidia.com/deploy/cuda-compatibility/index.html#minor-version-compatibility) to be installed in advance. It is possible to force conda to [override detection](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-virtual.html#overriding-detected-packages) when installation, but these requirements are still necessary during runtime.
9+
You can refer to [DeepModeling conda FAQ](https://docs.deepmodeling.com/faq/conda.html) for more information.
910
:::
1011

1112
- [Install off-line packages](#install-off-line-packages)
@@ -20,7 +21,7 @@ Both CPU and GPU version offline packages are available in [the Releases page](h
2021
Some packages are splited into two files due to size limit of GitHub. One may merge them into one after downloading:
2122

2223
```bash
23-
cat deepmd-kit-2.1.1-cuda11.6_gpu-Linux-x86_64.sh.0 deepmd-kit-2.1.1-cuda11.6_gpu-Linux-x86_64.sh.1 > deepmd-kit-2.1.1-cuda11.6_gpu-Linux-x86_64.sh
24+
cat deepmd-kit-2.2.9-cuda118-Linux-x86_64.sh.0 deepmd-kit-2.2.9-cuda118-Linux-x86_64.sh.1 > deepmd-kit-2.2.9-cuda118-Linux-x86_64.sh
2425
```
2526

2627
One may enable the environment using
@@ -31,10 +32,30 @@ conda activate /path/to/deepmd-kit
3132

3233
## Install with conda
3334

34-
DeePMD-kit is available with [conda](https://github.com/conda/conda). Install [Anaconda](https://www.anaconda.com/distribution/#download-section) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) first.
35+
DeePMD-kit is available with [conda](https://github.com/conda/conda). Install [Anaconda](https://www.anaconda.com/distribution/#download-section), [Miniconda](https://docs.conda.io/en/latest/miniconda.html), or [miniforge](https://conda-forge.org/download/) first.
36+
You can refer to [DeepModeling conda FAQ](https://docs.deepmodeling.com/faq/conda.html) for how to setup a conda environment.
37+
38+
### conda-forge channel
39+
40+
DeePMD-kit is available on the [conda-forge](https://conda-forge.org/) channel:
41+
42+
```bash
43+
conda create -n deepmd deepmd-kit lammps horovod -c conda-forge
44+
```
45+
46+
The supported platforms include Linux x86-64, macOS x86-64, and macOS arm64.
47+
Read [conda-forge FAQ](https://conda-forge.org/docs/user/tipsandtricks.html#installing-cuda-enabled-packages-like-tensorflow-and-pytorch) to learn how to install CUDA-enabled packages.
3548

3649
### Official channel
3750

51+
::::{danger}
52+
:::{deprecated} 3.0.0
53+
The official channel will be deprecated since 3.0.0.
54+
Old packages will still be available at https://conda.deepmodeling.com.
55+
Maintainers will build packages in the conda-forge organization together with other conda-forge members.
56+
:::
57+
::::
58+
3859
One may create an environment that contains the CPU version of DeePMD-kit and LAMMPS:
3960

4061
```bash
@@ -49,10 +70,10 @@ conda create -n deepmd deepmd-kit=*=*gpu libdeepmd=*=*gpu lammps cudatoolkit=11.
4970

5071
One could change the CUDA Toolkit version from `10.2` or `11.6`.
5172

52-
One may specify the DeePMD-kit version such as `2.1.1` using
73+
One may specify the DeePMD-kit version such as `2.2.9` using
5374

5475
```bash
55-
conda create -n deepmd deepmd-kit=2.1.1=*cpu libdeepmd=2.1.1=*cpu lammps horovod -c https://conda.deepmodeling.com -c defaults
76+
conda create -n deepmd deepmd-kit=2.2.9=*cpu libdeepmd=2.2.9=*cpu lammps horovod -c https://conda.deepmodeling.com -c defaults
5677
```
5778

5879
One may enable the environment using
@@ -61,20 +82,9 @@ One may enable the environment using
6182
conda activate deepmd
6283
```
6384

64-
### conda-forge channel
65-
66-
DeePMD-kit is also available on the [conda-forge](https://conda-forge.org/) channel:
67-
68-
```bash
69-
conda create -n deepmd deepmd-kit lammps horovod -c conda-forge
70-
```
71-
72-
The supported platform includes Linux x86-64, macOS x86-64, and macOS arm64.
73-
Read [conda-forge FAQ](https://conda-forge.org/docs/user/tipsandtricks.html#installing-cuda-enabled-packages-like-tensorflow-and-pytorch) to learn how to install CUDA-enabled packages.
74-
7585
## Install with docker
7686

77-
A docker for installing the DeePMD-kit is available [here](https://github.com/orgs/deepmodeling/packages/container/package/deepmd-kit).
87+
A docker for installing the DeePMD-kit is available [here](https://github.com/deepmodeling/deepmd-kit/pkgs/container/deepmd-kit).
7888

7989
To pull the CPU version:
8090

0 commit comments

Comments
 (0)