Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve setup documentation #143

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve setup documentation #143

wants to merge 3 commits into from

Conversation

TicaGit
Copy link
Collaborator

@TicaGit TicaGit commented Mar 3, 2025

Description:

While setting up the project, I ran into a few small issues that might affect other as well. I’ve updated the README.md with additional setup instructions. Additionally, I made minor modifications to config.py because it wasn't correctly sourcing the environment variables.

Copy link

github-actions bot commented Mar 3, 2025

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/stratigraphy
   __init__.py8188%11
   extract.py1821820%3–464
   get_files.py19190%3–47
   main.py1261260%3–333
src/stratigraphy/benchmark
   metrics.py594229%22–25, 29–32, 36–39, 46–49, 53–54, 58, 65–74, 78–91, 96–133
src/stratigraphy/data_extractor
   data_extractor.py76495%32, 45, 120, 164
   utility.py6350%28–36
src/stratigraphy/depth
   a_to_b_interval_extractor.py421369%40–57
   interval.py634332%40–86, 96, 107–123
src/stratigraphy/depths_materials_column_pairs
   bounding_boxes.py301067%23, 32, 50, 60, 72–78
   material_description_rect_with_sidebar.py211052%38–52
src/stratigraphy/evaluation
   evaluation_dataclasses.py491178%52, 71–74, 90, 104, 125–131, 147
   groundwater_evaluator.py48198%77
   layer_evaluator.py664630%29–30, 35–39, 47, 69–95, 105–113, 128–149
   metadata_evaluator.py371462%46–65, 86–93
   utility.py16756%43–52
src/stratigraphy/groundwater
   groundwater_extraction.py1469038%52, 94, 137–148, 180–184, 199–215, 226–314, 335–363
   utility.py423614%10–17, 30–50, 62–76, 91–105
src/stratigraphy/layer
   layer.py621182%21, 36, 64, 76, 91, 110, 113, 121, 136–139
src/stratigraphy/lines
   geometric_line_utilities.py86298%81, 131
   line.py51492%25, 50, 60, 110
   linesquadtree.py46198%75
src/stratigraphy/metadata
   coordinate_extraction.py106496%29, 93–94, 106
   elevation_extraction.py906033%34–39, 47, 55, 63, 79–87, 124–138, 150–153, 165–197, 212–220, 234–238
   language_detection.py181328%17–23, 37–45
   metadata.py662464%27, 83, 101–127, 146–155, 195–198, 206
src/stratigraphy/sidebar
   a_above_b_sidebar.py1223869%41, 44, 59–67, 80, 106, 114–121, 171–172, 214–255
   a_above_b_sidebar_validator.py311068%50, 53, 56, 58, 84–91
   a_to_b_sidebar.py431467%36, 49–50, 67, 95–108
   depthcolumnentry_extractor.py22291%43–44
   layer_identifier_sidebar.py46460%3–122
   layer_identifier_sidebar_extractor.py29290%3–75
   sidebar.py56591%42, 47, 68, 80, 83
   sidebarentry.py21195%31
src/stratigraphy/text
   description_block_splitter.py70297%24, 139
   extract_text.py29390%19, 53–54
   find_description.py41880%26–34, 111–114
   textblock.py901188%22, 27, 39, 44, 71, 79, 104, 116, 139, 160, 189
src/stratigraphy/util
   dataclasses.py32391%37–39
   predictions.py723453%72, 95–115, 143–187
   util.py341265%69–76, 90–92, 116–117
TOTAL241599559% 

Tests Skipped Failures Errors Time
107 0 💤 0 ❌ 0 🔥 8.020s ⏱️

@@ -167,6 +169,35 @@ The project structure and the most important files are as follows:

- `main.py` : This is the main script of the project. It runs the data extraction pipeline, which analyzes the PDF files in the `data/Benchmark` directory and saves the results in the `predictions.json` file.

## Data

To locally download the data from the AWS S3 bucket to the `./data` directory, run the following commands:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this already covered by the boreholes-download-profiles script that is documented higher up in this README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants