Skip to content

Clarifying a few steps in the install #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chyanju merged 2 commits into from
Jan 5, 2022
Merged

Clarifying a few steps in the install #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3a3f75
Clarifying a few steps in the install
jasonhemann May 6, 2021
6864491
Adding additional steps for potentially missing packages
jasonhemann Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,21 @@ Dev Environment Setup
- It is preferable to have a dedicated virtualenv for this project:
```
$ git clone <this repo>
$ cd Tyrell
$ cd <this repo>
$ cd tyrell
$ mkdir venv
$ python3 -m venv venv
$ source venv/bin/activate
$ cd ..
```
- Install R if you have not.
- Install the R packages `dplyr`, `tidyr`, and `compare`
- Make an editable install with `pip`. This would automatically handles package dependencies. One of our dependency, `z3-solver`, takes a long time to build. Please be patient.
```
$ python3 -m pip install --upgrade pip
$ pip install wheel sexpdata rpy2 compare
$ pip install -e ".[dev]"
$ python setup.py sdist # for package
$ python3 setup.py sdist # for package
```
- Test whether the installation is successful
```
Expand All @@ -30,7 +36,7 @@ Dev Environment Setup
$ python setup.py sdist
```
Tarball will be available at `dist/tyrell-<version>.tar.gz`
- Build HTML documentations
- Build HTML documentation
```
$ cd docs
$ make html
Expand Down