Skip to content

Commit eb81d81

Browse files
committed
fix installment document and file
1 parent b3d14ba commit eb81d81

File tree

2 files changed

+34
-5
lines changed

2 files changed

+34
-5
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,40 @@ The library requires *Python 3.7+*.
2525

2626
## Installation and Usage
2727

28-
Make sure you are using *Python 3.7+* for all below!
28+
Make sure you are using *Python 3.6+* for all below!
2929

30-
`python3 setup.py install`
30+
1. First, creat a virtual environment and activate the virtual environment.
3131

32-
After installation, we highly recommend you go through our [Tutorial](https://github.com/GemsLab/StrucEmbeddingLibrary/blob/master/Tutorial.ipynb) to see how SEMB library works.
32+
```bash
33+
python3 -m venv <VENV_NAME>
34+
source <VENV_NAME>/bin/activate
35+
```
36+
37+
2. Change directory to the `StrucEmbeddingLibrary` and install the dependencies
38+
39+
```bash
40+
(<VENV_NAME>) cd StrucEmbeddingLibrary
41+
(<VENV_NAME>) python3 -m pip install -r requirements.txt --no-cache-dir
42+
```
43+
44+
3. Install the `SEMB` package
45+
46+
```bash
47+
(<VENV_NAME>) cd StrucEmbeddingLibrary
48+
(<VENV_NAME>) python3 setup.py install
49+
```
50+
51+
After installation, we highly recommend you go through our [Tutorial](https://github.com/GemsLab/StrucEmbeddingLibrary/blob/master/Tutorial.ipynb) to see how SEMB library works.
52+
53+
4. To enable using the jupyter notebook, do the following,
54+
55+
```bash
56+
(<VENV_NAME>) python3 -m pip install ipykernel --no-cache-dir
57+
(<VENV_NAME>) python3 -m ipykernel install --name=<VENV_NAME>
58+
(<VENV_NAME>) jupyter notebook
59+
```
60+
61+
Choose `<VENV_NAME>` at the top right corner of the page when creating a new jupyter notebook / running the tutorial notebook.
3362

3463

3564

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@
2121
"License :: OSI Approved :: MIT License",
2222
"Operating System :: OS Independent",
2323
],
24-
python_requires='>=3.7',
25-
install_requires=requirements
24+
python_requires='>=3.6',
25+
# install_requires=requirements
2626
)

0 commit comments

Comments
 (0)