ReadyResearchers-2023-24 / Tugi-Artifact

Python VAR implementation of "Macroeconomic Variables that directly affects the Layoffs in Tech Sector"
0 stars 1 forks source link

Requirements #1

Open obonhamcarter opened 10 months ago

obonhamcarter commented 10 months ago

To run this code, there are several other commands which were not mentioned in your README.md file. Please update your user instructions with the following setup commands.

python3 -m venv myvenv # make a virtual environment
source myvenv/bin/activate # activate the virtual environment
pip install --upgrade pip # update pip
pip install streamlit # install Streamlit
pip install pandas # install Pandas
pip install numpy # install Numpy
pip install seaborn # install Seaborn
pip install matplotlib # install Matplotlib
pip install statsmodels # install Statmodels
streamlit run streamlit.py # run the dashboard

Note: you may want to change the name of your source code file (streamlit.py) to another name to situate this file with your project.

gkapfham commented 9 months ago

Hello @tuduun, thanks for creating this repository. In addition to asking you to address all of the issues raised by @obonhamcarter, I encourage you to please fix the formatting mistakes in the README.md file that show the commands that you should type. Right now, there is a mistake in the Markdown that prevents this content from rendering correctly. You should also include in the documentation an example of what the output looks like. Finally, it is important to note that your tool does not have a CI setup through GitHub Actions. Can you add each of these please?