Skip to content

Commit

Permalink
README.md: add usage information
Browse files Browse the repository at this point in the history
  • Loading branch information
alanorth committed Dec 9, 2024
1 parent 2b56665 commit 8825f94
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,25 @@ CGIAR institutional repositories used in this dataset (sorted by total number of
- UNIX-like operating system


## Usage

This project is managed using [uv](https://docs.astral.sh/uv/). You will need to install that first, or use a vanilla Python virtual environment to install the dependencies:

```console
$ python -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
```

Once the dependencies are installed you can run the pipeline:

```console
$ ./src/merge_source_csvs.py
```

This will use pre-harvested data from the `data` directory, as the harvest process can take many hours (up to 1 day). To update sources, use the `src/update_sources.sh` script. Caches are used where possible to speed up repeated runs.


## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).

Expand Down

0 comments on commit 8825f94

Please sign in to comment.