Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
redur committed Apr 3, 2024
1 parent 5cb87ed commit 3778b88
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,13 @@ To execute the data extraction pipeline, follow these steps:

`conda activate boreholes-dev`

2. **Run the main script**
2. **Run the extraction script**

The main script for the extraction pipeline is located at `src/stratigraphy/main.py`. Run this script to start the extraction process.
The main script for the extraction pipeline is located at `src/stratigraphy/main.py`. A cli command is created to run this script.

This script will source all PDFs from the `data/Benchmark` directory and create PNG files in the `data/Benchmark/extract` directory.
Run `boreholes-extract-materials` to run the main extraction script. With the default options, the command will source all PDFs from the `data/Benchmark` directory and create PNG files in the `data/Benchmark/extract` directory.

Use `boreholes-extract-materials --help` to see all options for the extraction script.

3. **Check the results**

Expand Down

0 comments on commit 3778b88

Please sign in to comment.