From 7b7a73581f4690b97c4c470a8af1305c9c3b07fe Mon Sep 17 00:00:00 2001 From: Hezheng Yin Date: Mon, 1 Apr 2019 20:35:54 -0700 Subject: [PATCH] Update README.md --- README.md | 120 ------------------------------------------------------ 1 file changed, 120 deletions(-) diff --git a/README.md b/README.md index 6aaf0b73c8f..5cebce8dea4 100644 --- a/README.md +++ b/README.md @@ -82,123 +82,3 @@ coverage html # then visit htmlcov/index.html in your browser ``` - - -## Interactive mode with jupyter notebook - -1. Install Jupyter - -Reference . - -E.g., on Ubuntu LTS 16.04: - -``` -sudo -H pip3 install --upgrade pip -sudo -H pip3 install jupyter -``` - -To automaically remove cell outputs and unnecessary meta information from notebook before committing, install jq (a lightweight and flexible command-line JSON processor) and activate it by running gitconfig.sh. E.g., on Ubuntu: - -``` -sudo apt install -y jq -./gitconfig.sh -``` - -2. Install pipenv kernel into jupyter notebook - -In the project folder, run - -``` -pipenv shell -``` - -This will bring up a terminal in your virtualenv like this: - -``` -(code-analytics-8iDyuztf) bash-3.2$ -``` - -In that shell, do - -``` -python -m ipykernel install --user --name=my-virtualenv-name -``` - -Launch jupyter notebook: - -``` -jupyter notebook -``` - -In your notebook, the new kernel should now be an option. Enjoy your interactions with the notebook! - - -## Analyze Javascript Projects - -Note: This section will be updated soon as we refactor the js graph server. - -Download the submodule `contribs/js-callgraph`: - -```bash -git submodule update --init --recursive -``` - -Run the following commands: - -```bash -npm install --prefix contribs/js-callgraph -pipenv install -pipenv run ./tools/repo_creater/create_repo.py test/js_test_repo/ -pipenv run pytest test/test_graphs/test_analyzer_js.py -``` - - -## Debug/Prod Mode for Java Server - -This is a debug and prod mode switch in Java analyzer, -by default the server is always in a debug mode, in case -you want to turn it into prod mode where any exception raised -is logged in a file and processing is not interrupted. - -We just need to set the environment variable: - -``export DEBUG_JAVA=False`` - -If this environment variable is set ot `False` then Prod mode is on -else Debug mode is on. - -## Trouble Shooting - -#### 1. No module named 'persper' - -Add this repo to python path so python can find the persper package. Insert the following line into `.bashrc` or `.bash_profile`. - -``` -export PYTHONPATH="/path/to/repo:$PYTHONPATH" -``` - - \ No newline at end of file