diff --git a/src/WHY.egg-info/PKG-INFO b/src/WHY.egg-info/PKG-INFO deleted file mode 100644 index 966ca3b6da9a140b0e0e73911402988621adf106..0000000000000000000000000000000000000000 --- a/src/WHY.egg-info/PKG-INFO +++ /dev/null @@ -1,85 +0,0 @@ -Metadata-Version: 2.1 -Name: WHY -Version: 0.0.1.dev0+a83d626 -Summary: Explainable AI system -Home-page: https://gitlab.cci.drexel.edu/pjm363/why-senior-project -Author: Philip Monaco, Abdullah Shah, Ibrahim Elsaid, Jashanpreet Singh, William Lu, Songheng Li -License: LICENSE.md -Platform: UNKNOWN -Requires-Python: >=3.8 -Description-Content-Type: text/markdown -Provides-Extra: lint -Provides-Extra: docs -Provides-Extra: all - -# WHY Senior Project - -## Installing WHY - -There are two way in which the `WHY` package can be installed. -First, follow the [prerequisite](#prerequisites) instructions. -IF you do not need to rebuild documentation or make modifications to the library, follow the instructions under [User Installation](#user-installation). -Otherwise, follow the instructions under [Developer Installation](#developer-installation). - -### Prerequisites - -The `WHY` requires at least `python3.8` and makes use of a number of third-party libraries. The bare minimum packages are automatically installed when you install `WHY` using `pip`. Additional dependencies for developers are contained in `requirements.txt` file. See the - -It's recommended that you use `WHY` within a python virtual environment. -Virtual environments are now included natively with Python 3 using `venv`. Instructions to create a virtual environment can be found [here](https://docs.python.org/3/library/venv.html). - -API documentation requires the use of `sphinx` which will require installing `Cmake`. Installation instructions can be found [here](https://cmake.org/install/). - -### User Installation - -First you must clone the repository using the following bash command. -```bash -pip clone git@gitlab.cci.drexel.edu:pjm363/why-senior-project.git -``` - -From the root path of the repository (the folder where `setup.py` is located) `WHY` can be installed using `pip` using the following command. - -```bash -pip install . -``` - -### Developer Installation -Developers need an additional tool, `clang-format` in order to run the precommit script. - -Install via Ubuntu. -```bash -apt-get install clang-format -``` -Install via MacOSX with homebrew. -```bash -brew install clang-format -``` -Install via [installer](https://llvm.org/builds/) or using chocolatey via. -```bash -choco install llvm -``` -Install WHY using pip: -```bash -pip install -e . -``` -## Running examples -From the `examples` directory -```bash -bokeh serve --show <name of app folder> -``` -For a developer option the `--dev` flag can be used to auto refresh server from IDE. -```bash -bokeh serve --show <name of app folder> --dev -``` -## Building API Documentation - -To build the API Documentation in HTML format for local browsing, execute the following from the root of the repository. -``` -cd docs/ -make html -``` - -This will also cause any examples contained in `examples` to be generated in the example gallery. -All documentation is also built automatically when the `./precommit.sh` script is run. - - diff --git a/src/WHY.egg-info/SOURCES.txt b/src/WHY.egg-info/SOURCES.txt deleted file mode 100644 index 59834884dd5805081d7d8e1f00f2df02d9f0d580..0000000000000000000000000000000000000000 --- a/src/WHY.egg-info/SOURCES.txt +++ /dev/null @@ -1,8 +0,0 @@ -README.md -setup.py -src/WHY.egg-info/PKG-INFO -src/WHY.egg-info/SOURCES.txt -src/WHY.egg-info/dependency_links.txt -src/WHY.egg-info/not-zip-safe -src/WHY.egg-info/requires.txt -src/WHY.egg-info/top_level.txt \ No newline at end of file diff --git a/src/WHY.egg-info/dependency_links.txt b/src/WHY.egg-info/dependency_links.txt deleted file mode 100644 index 8b137891791fe96927ad78e64b0aad7bded08bdc..0000000000000000000000000000000000000000 --- a/src/WHY.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/WHY.egg-info/not-zip-safe b/src/WHY.egg-info/not-zip-safe deleted file mode 100644 index 8b137891791fe96927ad78e64b0aad7bded08bdc..0000000000000000000000000000000000000000 --- a/src/WHY.egg-info/not-zip-safe +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/WHY.egg-info/requires.txt b/src/WHY.egg-info/requires.txt deleted file mode 100644 index e0c87a227f7df1ad1af7b1e909c526942b5ee70e..0000000000000000000000000000000000000000 --- a/src/WHY.egg-info/requires.txt +++ /dev/null @@ -1,32 +0,0 @@ -numpy>=1.21 -pandas>=1.3.5 -bokeh>=2.4.2 -matplotlib>=3.5.0 -scikit-learn>=1.0.2 - -[all] -numpy>=1.21 -pandas>=1.3.5 -bokeh>=2.4.2 -matplotlib>=3.5.0 -scikit-learn>=1.0.2 -black==21.12b0 -isort==5.10.1 -flake8==4.0.1 -mypy -Sphinx -sphinx-gallery -sphinx-rtd-theme -m2r2 - -[docs] -Sphinx -sphinx-gallery -sphinx-rtd-theme -m2r2 - -[lint] -black==21.12b0 -isort==5.10.1 -flake8==4.0.1 -mypy diff --git a/src/WHY.egg-info/top_level.txt b/src/WHY.egg-info/top_level.txt deleted file mode 100644 index 8b137891791fe96927ad78e64b0aad7bded08bdc..0000000000000000000000000000000000000000 --- a/src/WHY.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -