Skip to content

INSTRUCTIONS.md

Latest commit

 

History

History
318 lines (107 loc) · 5.5 KB

INSTRUCTIONS.md

File metadata and controls

318 lines (107 loc) · 5.5 KB
Raw

Back to DOCS.md

0. HOW TO USE THIS TEMPLATE

1. Git Clone this repository (project_name is the name of the project you want to create):

git clone https://github.com/ConnorAtmos/Stock_Analyzer <project_name>

2. CD into the project directory and remove the git repository:

cd <project_name> && rm -rf .git

3. Run structure_builder.py for next steps:

python3 structure_builder.py

You should then modify info.py. This file contains all the information about your project.

1. HOW TO INSTALL ANACONDA

Conda is a package manager for python. It is used to install python packages and conda packages.

1. CD into the home directory:

cd ~

2. Run the following command to download the conda installer:

wget [conda_install_link]


wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh

3. Run the following command to install conda:

bash [conda_file]


bash Anaconda3-2022.05-Linux-x86_64.sh

4. Run the following command to update conda:

conda update conda

5. Run the following command to install conda-forge:

conda config --add channels conda-forge

2. HOW TO CREATE CONDA ENVIRONMENT

This is for creating a new conda environment.

1. Run the following command to create a new conda environment:

conda create --name [project_name]


conda create --name Stock_Analyzer

2. Reload the bashrc file:

source ~/.bashrc

3. HOW TO CONNECT INTERPRETER TO JETBRAINS GATEWAY

1. Open the project in PyCharm

2. Go to File > Settings > Project: <project_name> > Python Interpreter

3. Click "Add Interpreter" > Add Local Interpreter > Conda Environment > Use Existing Environment

4. Click the drop down menu and select <project_name>.

4. HOW TO INSTALL REQUIREMENTS

This is for installing python packages and conda packages.

1. CD into the project directory:

cd [project_dir]


cd /home/connor/Stock_Analyzer

2. Activate the conda environment:

conda activate [project_name]


conda activate Stock_Analyzer

3. Install the following requirements:

pip install -r [requirements_file] && conda install --file [conda_requirements_file]  && conda install -c conda-forge --file [conda_forge_requirements_file]


pip install -r /home/connor/Stock_Analyzer/requirements/requirements.txt && conda install --file /home/connor/Stock_Analyzer/requirements/conda_requirements.txt  && conda install -c conda-forge --file /home/connor/Stock_Analyzer/requirements/conda_forge_requirements.txt

4. Install the following apt-get requirements:

[No apt-get requirements]

5. HOW TO INSTALL SERVICE

A service is a program that runs in the background. This is useful for running a program that you want to run all the time, such as a web server.

1. Run the following command to move the service file to the correct directory:

sudo mv [service_path] [service_moved_path]


sudo mv /home/connor/Stock_Analyzer/storage/Stock_Analyzer.service /etc/systemd/system/Stock_Analyzer.service

2. Reload the daemon:

sudo systemctl daemon-reload

3. Run the following command to enable the service:

sudo systemctl enable [service_name]


sudo systemctl enable Stock_Analyzer.service

4. Start the service:

sudo systemctl restart [service_name]


sudo systemctl restart Stock_Analyzer.service

5. View status of service:

sudo systemctl status [service_name]


sudo systemctl status Stock_Analyzer.service

To stop the service, run:

sudo systemctl stop [service_name]


sudo systemctl stop Stock_Analyzer.service

To disable the service, run:

sudo systemctl disable [service_name


sudo systemctl disable Stock_Analyzer.service

To view output of service easier:

journalctl --unit=[service_name] -n 100 --no-pager


journalctl --unit=Stock_Analyzer.service -n 100 --no-pager

6. HOW TO INSTALL SELENIUM AND CHROME

In order to get selenium to work, you must install Chrome.

1. Update

sudo apt-get update

2. Then upgrade with the following command

sudo apt-get upgrade

3. Install wget

sudo apt install wget

4. CD into your home directory

cd ~

5. Install latest version of chrome

wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb

6. Install chrome

sudo apt install ./google-chrome-stable_current_amd64.deb

Whenever prompted, type y and press enter.

You are done! Now you can use selenium with chrome.

A. HOW TO REMOVE CONDA ENVIRONMENT

This is for removing the conda environment.

1. Run the following command to remove the conda environment:

conda env remove --name [project_name]


conda env remove --name Stock_Analyzer

2. Reload the bashrc file:

source ~/.bashrc

B. HOW TO UNINSTALL SERVICE

This is for uninstalling and removing the service.

1. Run the following command to disable the service:

sudo systemctl disable [service_name]


sudo systemctl disable Stock_Analyzer.service

2. Run the following command to stop the service:

sudo systemctl stop [service_name]


sudo systemctl stop Stock_Analyzer.service

3. Run the following command to delete the service file:

sudo rm [service_moved_path]


sudo rm /etc/systemd/system/Stock_Analyzer.service