Skip to content

Commit

Permalink
ADD: Conda env and langfilter readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
WittmannF committed Sep 25, 2024
1 parent bcea9ca commit a2f82d3
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ optional arguments:
-h, --help show this help message and exit
--sortby SORTBY Column to be sorted by. Default is "Citations". To sort
by citations per year, use --sortby "cit/year"
--langfilter LANGFILTER [LANGFILTER ...]
Only languages listed are permitted to pass the filter.
List of supported language codes: zh-CN, zh-TW, nl, en, fr,
de, it, ja, ko, pl, pt, es, tr
--nresults NRESULTS Number of articles to search on Google Scholar. Default
is 100. (careful with robot checking if value is high)
--csvpath CSVPATH Path to save the exported csv file. Default is the
Expand Down Expand Up @@ -105,6 +109,12 @@ optional arguments:
sortgs '"deep learning" OR "neural networks" OR "machine learning"' --sortby "cit/year"
```
7. **Language Filter**:
```bash
sortgs "machine learning" --langfilter pt es fr de
```
This will only include articles in Portuguese, Spanish, French, and German.
### Output Example
While running, `sortgs` will provide updates in the terminal:
Expand All @@ -126,6 +136,25 @@ Loading next 20 results
If those steps are too complicated for you, send me an email with a list of keyworks that you'd like them ranked to: fernando [dot] wittmann [at] gmail [dot] com
## Conda Environment Setup
### Creating the Environment
```
conda env create -f conda_environment.yml
```
### Reset the environment
```
conda deactivate
conda remove --name sortgs --all
conda env create -f environment.yml
```
### Activate the environment
```
conda activate sortgs
```
## Running Project Using Docker
This guide will walk you through the process of installing Docker, pulling the `fernandowittmann/sort-google-scholar` Docker image, and running the project.
Expand Down
8 changes: 8 additions & 0 deletions conda_environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: sortgs
channels:
- defaults
dependencies:
- python=3.10
- pip
- pip:
- -e . # Install the package in editable mode

0 comments on commit a2f82d3

Please sign in to comment.