Skip to content

Commit

Permalink
Add instruction to run loadcorpora in readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
tijmenbaarda committed May 2, 2024
1 parent e7f7581 commit e22be47
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/First-time-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ _Note:_ these instructions are for indexing a corpus that already has a corpus d

1. Add the corpus to the `CORPORA` dictionary in your local settings file. See [CORPORA settings documentation](/documentation/Django-project-settings.md#corpora).
2. Set configurations for your corpus. Check the definition file to see which variables it expects to find in the configuration. Some of these may be optional, but you will at least need to define the (absolute) path to your source files.
3. Activate your python virtual environment. Create an ElasticSearch index from the source files by running, e.g., `yarn django index dutchannualreports`, for indexing the Dutch Annual Reports corpus in a development environment. See [Indexing](documentation/Indexing-corpora.md) for more information.
3. Activate your python virtual environment. Run the `loadcorpora` admin command (`yarn django loadcorpora`) to register the new corpus in the SQL database. Then create an ElasticSearch index from the source files by running, e.g., `yarn django index dutchannualreports`, for indexing the Dutch Annual Reports corpus in a development environment. See [Indexing](documentation/Indexing-corpora.md) for more information.

## Running a dev environment

Expand Down
1 change: 1 addition & 0 deletions documentation/Indexing-corpora.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ You can start indexing once you have
- A python source file for the corpus
- A directory with source data
- Added the necessary properties to django settings
- Run the admin command `loadcorpora` (`yarn django loadcorpora`)

The basic indexing command is:

Expand Down

0 comments on commit e22be47

Please sign in to comment.