Skip to content

Commit

Permalink
Updated documentation for harvest scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
RikDTJanssen committed Apr 18, 2023
1 parent bc6e08c commit 7a2f82e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/ricgraph_harvest_scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ order](#order-of-running-the-harvest-scripts).
### Organization abbreviation
Ricgraph uses the term *organization abbreviation*.
This is a string of a few letters that can be passed to some harvest
scripts to determine for which organisation such a script will harvest
scripts to determine for which organization such a script will harvest
data. Examples are *UU* or *UMCU*.

You will see this in keys in the
Expand Down Expand Up @@ -118,12 +118,12 @@ Options:
With this script, you can harvest persons, organizations and research outputs.
This script needs two parameters in the
[Ricgraph initialization file](ricgraph_install_configure.md#ricgraph-initialization-file):
The url to Pure in *pure_url_XXXX* and the Pure API key in *pure_api_key_XXXX*.
the url to Pure in *pure_url_XXXX*, and the Pure API key in *pure_api_key_XXXX*.
*XXXX* is your [organization abbreviation](#organization-abbreviation).

There is a lot of data in Pure, so your harvest may take a long time. You may
reduce this by adjusting parameters at the start of the script. Look in the sections
"Parameters for harvesting persons/organizations/research outputs from pure".
"Parameters for harvesting persons/organizations/research outputs from Pure".
E.g., for research outputs you can adjust
the years to harvest with the parameter *PURE_RESOUT_YEARS* and the maximum number of
records to harvest with *PURE_RESOUT_MAX_RECS_TO_HARVEST*.
Expand Down
4 changes: 2 additions & 2 deletions docs/ricgraph_script_writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The module code *ricgraph.py* can be found in directory [ricgraph](../ricgraph).
documented and hints to use it can be found in those files.

For more information about harvesting data,
see [Ricgraph harvest scripts](docs/ricgraph_harvest_scripts.md).
see [Ricgraph harvest scripts](ricgraph_harvest_scripts.md).

[Return to main README.md file](../README.md).

Expand Down Expand Up @@ -162,7 +162,7 @@ You can do the following to be able to use Neo4j Desktop and Ricgraph:
an easy to type and short one
since the DBMS will only be accessible from your own machine. Click "Create".
Also, insert the password in field *neo4j_password* in
the [Ricgraph initialization file](#Ricgraph-initialization-file).
the [Ricgraph initialization file](ricgraph_install_configure.md#ricgraph-initialization-file).
1. Ready.

### Return to main README.md file
Expand Down

0 comments on commit 7a2f82e

Please sign in to comment.