Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ A full [document](doc/train/train-input-auto.rst) on options in the training inp
- [Install GROMACS](doc/install/install-gromacs.md)
- [Building conda packages](doc/install/build-conda.md)
- [Install Node.js interface](doc/install/install-nodejs.md)
- [Easy install the latest development version](doc/install/easy-install-dev.md)
- [Data](doc/data/index.md)
- [System](doc/data/system.md)
- [Formats of a system](doc/data/data-conv.md)
Expand Down
4 changes: 2 additions & 2 deletions doc/development/cicd.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@

`Test CUDA` action runs tests on a self-hosted runner with the NVIDIA card. It is not triggered by every PR. The developer who has the permission to manage the label can apply the label `Test CUDA` to a PR to trigger this action.

<!-- ## CD -->
## CD

<!-- TODO: To be written... -->
GitHub Actions is used to build pre-compiled packages for each commit. See the [Easy install the latest development version](../install/easy-install-dev.md) section to learn how to install the latest development version.
31 changes: 31 additions & 0 deletions doc/install/easy-install-dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Easy install the latest development version

DeePMD-kit is actively developed in the `devel` branch. The documentation of the [`latest`](https://docs.deepmodeling.com/projects/deepmd/en/latest/) version matches the `devel` branch.

The following is the way to install the pre-compiled packages without [building from source](./install-from-source.md). All of them are built with [GitHub Actions](../development/cicd.md).

## Install with docker

The [`devel` tag](https://github.com/deepmodeling/deepmd-kit/pkgs/container/deepmd-kit/131827568?tag=devel) is used to mark the latest development version with CUDA support:

```bash
docker pull ghcr.io/deepmodeling/deepmd-kit:devel
```

## Install with pip

Below is an one-line shell command to download the [artifact](https://nightly.link/deepmodeling/deepmd-kit/workflows/build_wheel/devel/artifact.zip) containing wheels and install it with `pip`:

```sh
bash -c 'wget -O /tmp/z.$$ https://nightly.link/deepmodeling/deepmd-kit/workflows/build_wheel/devel/artifact.zip && unzip /tmp/z.$$ -d /tmp/dist.$$ && pip install -U --pre deepmd-kit[gpu,cu11,lmp] --find-links /tmp/dist.$$ && rm -r /tmp/z.$$ /tmp/dist.$$'
```

`cu11` and `lmp` are optional, which is the same as the stable version.

## Download pre-compiled C Library

The [pre-comiled C library](./install-from-c-library.md) can be downloaded from [here](https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/devel/libdeepmd_c.zip), or via a shell command:

```sh
wget https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/devel/libdeepmd_c.zip && unzip libdeepmd_c.zip
```
1 change: 1 addition & 0 deletions doc/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@
- [Install GROMACS](install-gromacs.md)
- [Building conda packages](build-conda.md)
- [Install Node.js interface](install-nodejs.md)
- [Easy install the latest development version](easy-install-dev.md)
1 change: 1 addition & 0 deletions doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Installation
install-gromacs
build-conda
install-nodejs
easy-install-dev