Skip to content

Commit

Permalink
Add venv note
Browse files Browse the repository at this point in the history
  • Loading branch information
kewbish committed Apr 29, 2024
1 parent e3daca8 commit c4088c9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation

1. Clone project with Git and install dependencies (see [REQUIREMENTS.md](./REQUIREMENTS.md)). For convenience, a VirtualBox image has been provided that automates this step (user is `fse2024`, password is `pass`). Note that Neo4j downloads as an AppImage on Linux, so you will need to run `chmod +x ./path-to-appimage.AppImage && ./path-to-appimage.AppImage` in order to run Neo4j. On the VirtualBox image, the Neo4j AppImage is located in the `~/Downloads` folder and the project has been cloned into the `~/pr-issue-topology-project` folder.
1. Clone project with Git and install dependencies (see [REQUIREMENTS.md](./REQUIREMENTS.md)). For convenience, a VirtualBox image has been provided that automates this step (user is `fse2024`, password is `pass`). Note that Neo4j downloads as an AppImage on Linux, so you will need to run `chmod +x ./path-to-appimage.AppImage && ./path-to-appimage.AppImage` in order to run Neo4j. On the VirtualBox image, the Neo4j AppImage is located in the `~/Downloads` folder and the project has been cloned into the `~/pr-issue-topology-project` folder. If using the VirtualBox image, make sure to `source venv/bin/activate` to activate the virtual environment with all the Python dependencies.
2. Download and import the data dump into Neo4j. A copy of the data dump is available [here](https://osf.io/3kexy). This can be done by clicking '+ Add' > 'File' > select the data dump, then clicking the ellipsis beside the `neo4j.dump` file that appears below in the `File` section and selecting 'Create new DBMS from dump'. Make a note of the password you use for later. Click 'Start' beside the new DBMS to start the server. This has already been done in the VirtualBox image, and the password is `testtest`.
![Creating a DBMS from the dump](./docs/images/neo4j_create.png)
3. To check that the data was imported correctly, click 'Open' beside the new DBMS. Go into the `cypher_scripts` folder in the project and pick a Cypher query to run. Copy-paste its contents into the query box in Neo4j and click the play button.
Expand Down

0 comments on commit c4088c9

Please sign in to comment.