-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
41 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# SERD | ||
|
||
[![PyPI - Version](https://img.shields.io/pypi/v/SERD)](https://pypi.org/project/SERD/) | ||
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/SERD)](https://pypi.org/project/SERD/) | ||
[![PyPI - Downloads](https://img.shields.io/pypi/dm/SERD)](https://pypi.org/project/SERD/) | ||
|
||
A Python package to detect solvent-exposed residues of a target biomolecule. | ||
|
||
See also: | ||
|
||
- [GitHub repository](https://github.com/LBC-LNBio/SERD/) | ||
- [Documentation and tutorial](https://lbc-lnbio.github.io/SERD/) | ||
|
||
## Installation | ||
|
||
To install the latest release on [PyPI](https://pypi.org/project/SERD), run: | ||
|
||
```bash | ||
pip install SERD | ||
``` | ||
|
||
Or to install the latest developmental version, run: | ||
|
||
```bash | ||
git clone https://github.com/LBC-LNBio/SERD.git | ||
pip install -e SERD | ||
``` | ||
|
||
## Citation | ||
|
||
If you use *SERD* package, please cite: | ||
|
||
Guerra, J. V. S., Jara, G. E., Pereira, J. G. C., & Lopes-de-Oliveira, P. S. (2022). SERD (Version v0.1.2) [Computer software]. https://github.com/LBC-LNBio/SERD. | ||
|
||
## License | ||
|
||
The software is licensed under the terms of the GNU General Public License version 3 (GPL3) and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta" | |
[project] | ||
name = "SERD" | ||
description = "A Python package to detect solvent-exposed residues of a target biomolecule." | ||
readme = { file = "README.rst", content-type = "text/x-rst" } | ||
readme = { file = "README.md", content-type = "text/markdown" } | ||
requires-python = ">=3.10, <4" | ||
license = { file = "LICENSE" } | ||
authors = [ | ||
|
@@ -19,6 +19,7 @@ authors = [ | |
{ name = "José G. C. Pereira" }, | ||
{ name = "Helder V. Ribeiro-Filho" }, | ||
] | ||
maintainers = [{ name = "João V. S. Guerra", email = "[email protected]" }] | ||
classifiers = [ | ||
"Development Status :: 4 - Beta", | ||
"Intended Audience :: Science/Research", | ||
|
@@ -29,6 +30,7 @@ classifiers = [ | |
"Programming Language :: Python :: 3.10", | ||
"Programming Language :: Python :: 3.11", | ||
"Programming Language :: Python :: 3.12", | ||
"Programming Language :: Python :: 3.13", | ||
"Programming Language :: Python :: 3 :: Only", | ||
] | ||
dependencies = [ | ||
|
@@ -47,7 +49,7 @@ keywords = [ | |
|
||
[project.urls] | ||
homepage = "https://github.com/LBC-LNBio/SERD" | ||
source = "https://github.com/LBC-LNBio/SERD/" | ||
documentation = "https://lbc-lnbio.github.io/SERD/ " | ||
issues = "https://github.com/LBC-LNBio/SERD/issues" | ||
|
||
[tool.setuptools] | ||
|