@@ -23,3 +23,88 @@ the following environment:
23
23
Replicating this environment is crucial for stability and performance.
24
24
25
25
## Complete Installation Guide
26
+
27
+ This project has many dependencies. Most can be installed using ` pip ` . Some require OS-level package managers. This is
28
+ going to work best in Linux-based systems.
29
+
30
+ ### Linux (Ubuntu-based Systems)
31
+ First install ` Python 3 ` and ` pip ` :
32
+ ``` commandline
33
+ sudo apt python3 python3-dev python3-pip
34
+ ```
35
+ Next, we need to install Firefox and its corresponding ` geckodriver ` for headless Selenium searches:
36
+ ``` commandline
37
+ sudo apt install firefox
38
+ ```
39
+
40
+ ** Note:** If you get an error regarding the geckodriver, you can install it manually by following the instructions
41
+ [ here] ( https://github.com/mozilla/geckodriver ) .
42
+
43
+ #### Install System Packages
44
+ Next, we need to install the system packages that MAGIST uses.
45
+ ``` commandline
46
+ sudo apt install python3-pyaudio
47
+ sudo apt install libasound-dev
48
+ ```
49
+
50
+ #### MongoDB
51
+ Next, we need to install MongoDB. This is a database that MAGIST uses to store its data.
52
+ ``` commandline
53
+ wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -
54
+ ```
55
+
56
+ If you get an error with the command above, you need to install ` gnupg ` and then reimport the key.
57
+ ``` commandline
58
+ sudo apt install gnupg
59
+ wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -
60
+ ```
61
+
62
+ Next, we need to make the list file:
63
+ ``` commandline
64
+ echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
65
+ ```
66
+
67
+ Reload the package list:
68
+ ``` commandline
69
+ sudo apt update
70
+ ```
71
+
72
+ Finally install MongoDB:
73
+ ``` commandline
74
+ sudo apt install mongodb-org
75
+ ```
76
+
77
+ Next, create a Python environment. There are 2 ways to do this: Anaconda or VEnv.
78
+
79
+ #### Anaconda
80
+ First install Anaconda from https://www.anaconda.com/ .
81
+
82
+ Make the Anaconda environment:
83
+ ``` commandline
84
+ conda create --name myenv
85
+ ```
86
+ Activate the environment in your current console. Note: You will have to do this every time you want to run MAGIST.
87
+ ``` commandline
88
+ conda activate myenv
89
+ ```
90
+ Install MAGIST:
91
+ ``` commandline
92
+ pip3 install MAGIST-Algorithm-x.x.x-py3-none-any.whl
93
+ ```
94
+
95
+ #### VEnv
96
+ Make the environment in a designated location.
97
+ ``` commandline
98
+ python3 -m venv /path/to/new/virtual/environment
99
+ ```
100
+ To activate it, you must travel to that ` path/bin/ ` and then run:
101
+ ``` commandline
102
+ source activate
103
+ ```
104
+ Install MAGIST:
105
+ ``` commandline
106
+ pip3 install MAGIST-Algorithm-x.x.x-py3-none-any.whl
107
+ ```
108
+
109
+ ** Congratulations! You are all setup to script and use MAGIST**
110
+
0 commit comments