Skip to content
This repository has been archived by the owner on Mar 3, 2024. It is now read-only.

Update Readme Files #41

Merged
merged 8 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Even better, you can submit a Pull Request with a patch.
## Feature requests

We highly appreciate your contributions, and would like to help you crafting the changes and making contributions to the community.
If you would like to implement a new feature, please **submit a feature requesting issue with a proposal for your work first**.
If you would like to implement a new feature, please **submit a feature requesting issue with a proposal for your work first**.
This help fitting your ideas and work with the development road map well, coordinating our efforts, and avoiding duplication of work.

## Submitting a Pull Request
Expand All @@ -35,7 +35,7 @@ This help fitting your ideas and work with the development road map well, coordi
```

5. On GitHub, create a pull request (PR) from your bug-fix branch targeting `dptech-corp/Uni-Dock`.

6. After your pull request is merged, you can safely delete your branch and sync the changes from the main (upstream) repository:

- Delete the remote branch on GitHub either [through the GitHub web UI](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request) or your local shell as follows:
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<picture><source media="(prefers-color-scheme: dark)" srcset="./unidock/assets/logo-dark.svg"><source media="(prefers-color-scheme: light)" srcset="./unidock/assets/logo.svg"><img alt="Uni-Dock logo" src="./unidock/assets/logo.svg"></picture>

[![DeepModeling](https://img.shields.io/badge/DeepModeling-Incubating_Project-blue)](https://github.com/deepmodeling)

## Introduction
caic99 marked this conversation as resolved.
Show resolved Hide resolved

**Uni-Dock** is a GPU-accelerated molecular docking program developed by DP Technology.
Expand All @@ -14,6 +15,7 @@ The [paper](https://pubs.acs.org/doi/10.1021/acs.jctc.2c01145) has been accepted
Check this [subfolder](./unidock/) for instructions on installing Uni-Dock.
caic99 marked this conversation as resolved.
Show resolved Hide resolved

**Uni-Dock** joins the DeepModeling community, a community devoted of AI for science, as an incubating level project. To learn more about the DeepModeling community, see the [introduction of community](https://github.com/deepmodeling/community).
caic99 marked this conversation as resolved.
Show resolved Hide resolved

## UniDockTools

**UniDockTools** is a python package developed to handle the inputs and outputs of Uni-Dock.
Expand Down
18 changes: 14 additions & 4 deletions unidock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ The [paper](https://pubs.acs.org/doi/10.1021/acs.jctc.2c01145) has been accepted

## Changelog
caic99 marked this conversation as resolved.
Show resolved Hide resolved

- 2023-08-14: Add `unidock_tools` to support SDF format input for vina and vinardo scoring functions.
Major changes are documented. For the detailed changes, please refer to the commit history.

### v1.1

- Optimize 1:1 ligand docking.
- Optimize Monte-Carlo simulation speed.
- Generate compute kernels for various ligands sizes.

## License

Expand Down Expand Up @@ -57,7 +63,7 @@ The performance is not guaranteed on legacy GPU models. To build Uni-Dock with a
# Otherwise, prepend the building directory to your `PATH` environment variable.
```

code foramt
To format codes if changes are made:

```shell
cd ./build/
Expand Down Expand Up @@ -195,9 +201,13 @@ python run_dock.py

If you want to use search mode presets, specify the parameter `search_mode` in `config.json` and delete `nt` and `ns` in `config.json`.

## Bug Report
## Contributing

We warmly welcome contributions from the open-source community. Your bug reports, feature requests, and pull requests helps Uni-Dock improve.

Please submit bug reports and feature requests to the Github [issue tracker](https://github.com/dptech-corp/Uni-Dock/issues/new/choose).

Please report bugs to [Issues](https://github.com/dptech-corp/Uni-Dock/issues) page.
If you would like to improve the codes, please refer to the [contributing guide](../.github/CONTRIBUTING.md) for details.

## Ackowledgement

Expand Down
2 changes: 1 addition & 1 deletion unidock_tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ By installing UniDockTools, you have obtained an executable file called **Unidoc

## Use ligands structure as bias

`Unidock --receptor receptor.pdbqt --gpu_batch ligand1.sdf ligand2.sdf --reference ref1.sdf ref2.sdf --scoring gnina --center_x 9 --center_y -5 --center_z -5 --size_x 20 --size_y 20 --size_z 20 --search_mode balance --dir . `
`Unidock --receptor receptor.pdbqt --gpu_batch ligand1.sdf ligand2.sdf --reference ref1.sdf ref2.sdf --scoring gnina --center_x 9 --center_y -5 --center_z -5 --size_x 20 --size_y 20 --size_z 20 --search_mode balance --dir .`

## Other usage

Expand Down
Loading