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
2 changes: 0 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ updates:
directory: "/"
schedule:
interval: "weekly"
target-branch: "devel"
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
target-branch: "devel"
2 changes: 1 addition & 1 deletion .github/workflows/build_wheel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ jobs:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
if: github.event_name == 'push' && github.ref == 'refs/heads/devel' && github.repository_owner == 'deepmodeling'
if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository_owner == 'deepmodeling'
steps:
- name: Deploy to GitHub Pages
id: deployment
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/todo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: TODO workflow
on:
push:
branches:
- devel
- master
jobs:
build:
if: github.repository_owner == 'deepmodeling'
Expand Down
2 changes: 0 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -159,5 +159,3 @@ repos:
- id: pylint
entry: env PYTHONPATH=source/checker pylint
files: ^deepmd/
ci:
autoupdate_branch: devel
19 changes: 5 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,6 @@ You can help other users of deepmd-kit in the following way

## Before you contribute

### Overview of DeePMD-kit

Currently, we maintain two main branch:

- master: stable branch with version tag
- devel : branch for developers

### Developer guide

See [documentation](https://deepmd.readthedocs.io/) for coding conventions, API and other needs-to-know of the code.
Expand All @@ -58,13 +51,11 @@ Please perform the following steps to create your Pull Request to this repositor

### Step 2: Clone the forked repository to local storage and set configurations

1. Clone your own repo, not the public repo (from deepmodeling) ! And change the branch to devel.
1. Clone your own repo, not the public repo (from deepmodeling) !

```bash
git clone https://github.com/$username/deepmd-kit.git
# Replace `$username` with your GitHub ID

git checkout devel
```

2. Add deepmodeling's repo as your remote repo, we can name it "upstream". And fetch upstream's latest codes to your workstation.
Expand All @@ -76,23 +67,23 @@ Please perform the following steps to create your Pull Request to this repositor
git fetch upstream

# If your current codes are behind the latest codes, you should merge latest codes first.
# Notice you should merge from "devel"!
git merge upstream/devel
git merge upstream/master
```

3. Modify your codes and design unit tests.

4. Commit your changes
4. Commit your changes to a new branch

```bash
git checkout -b branch1
git status # Checks the local status
git add <file> ... # Adds the file(s) you want to commit. If you want to commit all changes, you can directly use `git add.`
git commit -m "commit-message: update the xx"
```

5. Push the changed codes to your original repo on github.
```bash
git push origin devel
git push origin branch1
```

### Alternatively: Create a new branch
Expand Down
10 changes: 5 additions & 5 deletions doc/install/easy-install-dev.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# 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.
DeePMD-kit is actively developed in the `master` branch. The documentation of the [`latest`](https://docs.deepmodeling.com/projects/deepmd/en/latest/) version matches the `master` 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 12.2 support:
The `master` tag is used to mark the latest development version with CUDA 12.2 support:

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

## Install with pip
Expand All @@ -26,10 +26,10 @@ pip install -U --pre deepmd-kit[gpu,cu12,lmp,torch] --extra-index-url https://de
**Supported backends**: TensorFlow {{ tensorflow_icon }}
:::

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-0-libdeepmd_c.tar.gz.zip), or via a shell command:
The [pre-compiled C library](./install-from-c-library.md) can be downloaded from [here](https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/master/libdeepmd_c-0-libdeepmd_c.tar.gz.zip), or via a shell command:

```sh
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
wget https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/master/libdeepmd_c-0-libdeepmd_c.tar.gz.zip && unzip libdeepmd_c-0-libdeepmd_c.tar.gz.zip
```

## Pre-release conda-forge packages
Expand Down
2 changes: 1 addition & 1 deletion doc/install/install-from-source.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Install from source code

Please follow our [GitHub](https://github.com/deepmodeling/deepmd-kit) webpage to download the [latest released version](https://github.com/deepmodeling/deepmd-kit/tree/master) and [development version](https://github.com/deepmodeling/deepmd-kit/tree/devel).
Please follow our [GitHub](https://github.com/deepmodeling/deepmd-kit) webpage to download the source code of a specific version or the [development version](https://github.com/deepmodeling/deepmd-kit/tree/master).

Or get the DeePMD-kit source code by `git clone`

Expand Down