Skip to content

Commit

Permalink
added windows instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Becca Wilson authored and Becca Wilson committed Aug 3, 2020
1 parent 8fcd52a commit 2169e70
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,32 @@ A demo with some of the functionality is at: [https://ollybutters.github.io/puma

The wiki (<https://github.com/OllyButters/puma/wiki>) has the best instructions, but in overview:

### Linux
- Assuming a linux environment with python 3 installed.
- Add all the required python libraries with the requirements.txt file in the source folder:

`pip3 install -r requirements.txt`
- Edit the config.ini file in the config folder so it has your API keys etc.
- Run the pipeline from within the source folder with a command like:

`./papers.py`

- Or you can run it from within an IDE.
- Once it has finished, have a look at the web pages in the html folder. Pay particular attention to the coverage_report.html file.

### Windows
- Assuming a windows environment (I've only tried Windows 10) with python 3 installed (at least python 3.6 as utf-8 support is a little flakey before that).
- Add all the required python libraries with the requirements.txt file in the source folder by running a command like the following with the command prompt:

`py -3 -m pip install --user -r requirements.txt`
- Edit the config.ini file in the config folder so it has your API keys etc.
- Run the pipeline with a command like:
`./papers.py`

`python papers.py`
- Or you can run it from within an IDE.
- Once it has finished, have a look at the web pages in the html folder. Pay particular attention to the coverage_report.html file.


## PUMA project publications

Butters et al., 2019. DOI: [10.12688/wellcomeopenres.14986.1](https://dx.doi.org/10.12688%2Fwellcomeopenres.14986.1)
Expand Down

0 comments on commit 2169e70

Please sign in to comment.