Commit
•
c2b236f
1
Parent(s):
eaba7e8
Updated installation link
Browse files- README.md +1 -3
- docs/README.md +1 -0
- docs/index.rst +5 -6
README.md
CHANGED
|
@@ -26,9 +26,7 @@ The folder [data/studies](data/studies/) contains the training and test data use
|
|
| 26 |
To install the package, open your terminal and run the following commands:
|
| 27 |
|
| 28 |
```bash
|
| 29 |
-
|
| 30 |
-
cd PROTAC-Degradation-Predictor
|
| 31 |
-
pip install .
|
| 32 |
```
|
| 33 |
|
| 34 |
The package has been developed on a Linux machine with Python 3.10.8. It is recommended to use a virtual environment to avoid conflicts with other packages.
|
|
|
|
| 26 |
To install the package, open your terminal and run the following commands:
|
| 27 |
|
| 28 |
```bash
|
| 29 |
+
pip install git+https://github.com/ribesstefano/PROTAC-Degradation-Predictor.git
|
|
|
|
|
|
|
| 30 |
```
|
| 31 |
|
| 32 |
The package has been developed on a Linux machine with Python 3.10.8. It is recommended to use a virtual environment to avoid conflicts with other packages.
|
docs/README.md
CHANGED
|
@@ -45,6 +45,7 @@
|
|
| 45 |
```
|
| 46 |
8. Generate the specific workflow Action file:
|
| 47 |
- See file `.github/workflows/gh-pages.yml` in this repository.
|
|
|
|
| 48 |
|
| 49 |
## Miscellaneous
|
| 50 |
|
|
|
|
| 45 |
```
|
| 46 |
8. Generate the specific workflow Action file:
|
| 47 |
- See file `.github/workflows/gh-pages.yml` in this repository.
|
| 48 |
+
9. The start page is in the file `index.rst`.
|
| 49 |
|
| 50 |
## Miscellaneous
|
| 51 |
|
docs/index.rst
CHANGED
|
@@ -9,6 +9,8 @@ PROTAC-Degradation-Predictor: Documentation and Overview
|
|
| 9 |
|
| 10 |
**PROTAC-Degradation-Predictor** is a Python package designed to predict the activity of PROTAC molecules using advanced machine learning techniques. The tool aims to assist researchers in evaluating the potential effectiveness of PROTACs, a novel class of drugs that target protein degradation.
|
| 11 |
|
|
|
|
|
|
|
| 12 |
.. .. image:: https://yourimageurl.com/logo.png # Add your project's logo or any relevant image
|
| 13 |
.. :align: center
|
| 14 |
|
|
@@ -38,10 +40,7 @@ To get started with PROTAC-Degradation-Predictor, follow these steps:
|
|
| 38 |
Install the package using pip:
|
| 39 |
|
| 40 |
.. code-block:: bash
|
| 41 |
-
|
| 42 |
-
git clone https://github.com/ribesstefano/PROTAC-Degradation-Predictor.git
|
| 43 |
-
cd PROTAC-Degradation-Predictor
|
| 44 |
-
pip install .
|
| 45 |
|
| 46 |
2. **Basic Usage**:
|
| 47 |
Here's an example of how to predict PROTAC activity:
|
|
@@ -101,11 +100,11 @@ About
|
|
| 101 |
|
| 102 |
**Author**: Stefano Ribes
|
| 103 |
|
| 104 |
-
**Version**: v1.0.
|
| 105 |
|
| 106 |
Built with Sphinx using the `Read the Docs theme <https://sphinx-rtd-theme.readthedocs.io/>`_.
|
| 107 |
|
| 108 |
----------
|
| 109 |
|
| 110 |
-
*This documentation was last updated on August
|
| 111 |
|
|
|
|
| 9 |
|
| 10 |
**PROTAC-Degradation-Predictor** is a Python package designed to predict the activity of PROTAC molecules using advanced machine learning techniques. The tool aims to assist researchers in evaluating the potential effectiveness of PROTACs, a novel class of drugs that target protein degradation.
|
| 11 |
|
| 12 |
+
The package Github repository can be found `here <https://github.com/ribesstefano/PROTAC-Degradation-Predictor.git>`_.
|
| 13 |
+
|
| 14 |
.. .. image:: https://yourimageurl.com/logo.png # Add your project's logo or any relevant image
|
| 15 |
.. :align: center
|
| 16 |
|
|
|
|
| 40 |
Install the package using pip:
|
| 41 |
|
| 42 |
.. code-block:: bash
|
| 43 |
+
pip install git+https://github.com/ribesstefano/PROTAC-Degradation-Predictor.git
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
2. **Basic Usage**:
|
| 46 |
Here's an example of how to predict PROTAC activity:
|
|
|
|
| 100 |
|
| 101 |
**Author**: Stefano Ribes
|
| 102 |
|
| 103 |
+
**Version**: v1.0.2
|
| 104 |
|
| 105 |
Built with Sphinx using the `Read the Docs theme <https://sphinx-rtd-theme.readthedocs.io/>`_.
|
| 106 |
|
| 107 |
----------
|
| 108 |
|
| 109 |
+
*This documentation was last updated on August 27, 2024.*
|
| 110 |
|