From 2782262caf689cbe41b1f529ec02b53c71221715 Mon Sep 17 00:00:00 2001 From: Jamey Date: Wed, 21 Oct 2020 22:24:38 -0400 Subject: [PATCH] Added gitignore file. Added initial requirements file. Readme updated. Jamey Calabrese --- .gitignore | 2 ++ README.md | 29 +++++++++++++++++------------ requirements.txt | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+), 12 deletions(-) create mode 100644 .gitignore create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..82adb58 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__ +venv diff --git a/README.md b/README.md index 9437eae..9a6697b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ # CSE Senior Design Project Group 28 -## Hello World! +## Environment Configuration -For right now this is an empty repository. This will hold everything we -work on for the coming year. We'll all work in separate branches in order -to make collaboration simple. +Please go here https://docs.python.org/3.8/tutorial/venv.html for detailed instructions on configuring a virtual environment. +It is important that you create the virtual environment in the "./venv" directory. The .gitignore file has been configured +for the virtual environment to be located in "./venv". -## What's next +## Install necessary packages -We'll have to create a project write up. This can exist in a markdown file -or it can exist as a PDF commited into the repository. That's the next step -on the plate. +Once you have configured your virtual environment you must first activate it with -After we pin down an initial design we'll have to setup a python environment -for the repository. This will lock the python3 version so all of us are working -with the same interpreter. This is extremely important and should addressed -before a single line of code is written. +"source venv/bin/activate" - macOS or Linux + +"venv\Scripts\activate.bat" - Windows + +NOTE: These commands assume that you are currently located in the upper most working directory + +To install the necessary packages execute the following + +"pip install -r requirements.txt" + +All current required packages will be downloaded and installed. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7763fb4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,38 @@ +absl-py==0.10.0 +astunparse==1.6.3 +cachetools==4.1.1 +certifi==2020.6.20 +chardet==3.0.4 +gast==0.3.3 +google-auth==1.22.1 +google-auth-oauthlib==0.4.1 +google-pasta==0.2.0 +grpcio==1.33.1 +h5py==2.10.0 +idna==2.10 +Keras==2.4.3 +Keras-Preprocessing==1.1.2 +Markdown==3.3.2 +numpy==1.18.5 +oauthlib==3.1.0 +opt-einsum==3.3.0 +pandas==1.1.3 +protobuf==3.13.0 +pyasn1==0.4.8 +pyasn1-modules==0.2.8 +python-dateutil==2.8.1 +pytz==2020.1 +PyYAML==5.3.1 +requests==2.24.0 +requests-oauthlib==1.3.0 +rsa==4.6 +scipy==1.5.3 +six==1.15.0 +tensorboard==2.3.0 +tensorboard-plugin-wit==1.7.0 +tensorflow==2.3.1 +tensorflow-estimator==2.3.0 +termcolor==1.1.0 +urllib3==1.25.11 +Werkzeug==1.0.1 +wrapt==1.12.1