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: 1 addition & 1 deletion .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following packages are installed into the Python environment `.venv`:
- LAMMPS
- MPICH
- CMake
- pre-commit (including hooks)
- prek (including hooks)
- Test packages including pytest
- Doc packages including sphinx

Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/build_py.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ SCRIPT_PATH=$(dirname $(realpath -s $0))
cd ${SCRIPT_PATH}/..

uv sync --dev --python 3.12 --extra cpu --extra torch --extra jax --extra lmp --extra test --extra docs
pre-commit install
prek install
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"features": {
"ghcr.io/devcontainers/features/github-cli:1": {}
},
"postCreateCommand": ".devcontainer/build_py.sh && .devcontainer/download_libtorch.sh && .devcontainer/build_cxx.sh && pre-commit install-hooks",
"postCreateCommand": ".devcontainer/build_py.sh && .devcontainer/download_libtorch.sh && .devcontainer/build_cxx.sh && prek install-hooks",
"remoteEnv": {
"PATH": "${containerEnv:PATH}:${containerWorkspaceFolder}/.venv/bin",
"DP_ENABLE_PYTORCH": "1",
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ body:
- docker
- pip
- Built from source
- dp1s
- Others (write below)
validations:
required: true
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/copilot-setup-steps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ jobs:
- name: Build Python package
run: uv pip install -e .[cpu,test]

- name: Install pre-commit tools
run: uv tool install pre-commit
- name: Install prek tools
run: uv tool install prek

- name: Install pre-commit hooks
run: pre-commit install --install-hooks
- name: Install prek hooks
run: prek install --install-hooks

- name: Verify installation
run: |
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ repos:
hooks:
- id: flake8
additional_dependencies:
- torchfix==0.6.0
- torchfix==0.7.0
- flake8-pyproject==1.2.3
# numpydoc
- repo: https://github.com/Carreau/velin
Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,19 @@ See [our v3 paper](https://doi.org/10.1021/acs.jctc.5c00340) for details of all

## Install and use DeePMD-kit

Please read the [online documentation](https://deepmd.readthedocs.io/) for how to install and use DeePMD-kit.
Just copy and paste in 1s, and let it run.

```sh
curl -fsSL https://dp1s.deepmodeling.com | bash
```

Please read the [online documentation](https://deepmd.readthedocs.io/) for details and alternative installation methods.

Then, read on for a brief overview of the usage of DeePMD-kit. You may start with the first step:

```sh
dp
```

## Code structure

Expand Down
6 changes: 3 additions & 3 deletions doc/development/coding-conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@ style with some modifications.
Run scripts to check the code
=============================

It's a good idea to install `pre-commit <https://pre-commit.com>`_ on your repository:
It's a good idea to install `prek <https://github.com/j178/prek>`_ on your repository:

.. code-block:: bash

$ pip install pre-commit
$ pre-commit install
$ uv tool install prek
$ prek install

The scripts will be run automatically before each commit and will fix the code style
issues automatically.
13 changes: 9 additions & 4 deletions doc/install/easy-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@ You can refer to [DeepModeling conda FAQ](https://docs.deepmodeling.com/faq/cond
Python 3.10 or above is required for Python interface.
:::

- [Install off-line packages](#install-off-line-packages)
- [Install with conda](#install-with-conda)
- [Install with docker](#install-with-docker)
- [Install Python interface with pip](#install-python-interface-with-pip)
## Install DeePMD-kit in 1s

Just copy and paste in 1s, and let it run.

```sh
curl -fsSL https://dp1s.deepmodeling.com | bash
```

More options are provided, as documented in the [dp1s repository](https://github.com/deepmodeling-activity/dp1s).

## Install off-line packages

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ dp = "deepmd.main:main"

[dependency-groups]
dev = [
"pre-commit",
"prek",
"cmake",
"mpich",
]
Expand Down
Loading