Skip to content

Commit 812f51e

Browse files
committed
Add elm ords install instructions
1 parent 68596a8 commit 812f51e

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

README.rst

+3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ Installing ELM
3333

3434
.. inclusion-install
3535
36+
NOTE: If you are installing ELM to run ordinance scraping and extraction,
37+
see the `ordinance-specific installation instructions <https://github.com/NREL/elm/blob/main/elm/ords/README.md>`_.
38+
3639
Option #1 (basic usage):
3740

3841
#. ``pip install NREL-elm``

elm/ords/README.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Welcome to Energy Language Model - OrdinanceGPT
2+
3+
The ordinance web scraping and data extraction portion of this codebase required a few extra dependencies that do not come out-of-the-box with the base ELM software.
4+
To set up ELM for ordinances, first create a conda environment. Then, _before installing ELM_, run the poppler installation:
5+
6+
$ conda install -c conda-forge poppler
7+
8+
Then, install `pdftotext`:
9+
10+
$ pip install pdftotext
11+
12+
(OPTIONAL) If you want to have access to Optical Character Recognition (OCR) for PDF parsing, you should also install pytesseract during this step:
13+
14+
$ pip install pytesseract pdf2image
15+
16+
At this point, you can install ELM per the [front-page README](https://github.com/NREL/elm/blob/main/README.rst) instructions.
17+
18+
After ELM installs successfully, you must instantiate the playwright module, which is used for web scraping.
19+
To do so, simply run:
20+
21+
$ playwright install
22+
23+
Now you are ready to run ordinance retrieval and extraction. See the [example](https://github.com/NREL/elm/blob/main/examples/ordinance_gpt/README.rst) to get started.

requirements.txt

-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ nrel-rex
1111
nltk
1212
numpy
1313
pandas
14-
pdftotext
1514
playwright
1615
PyPDF2
1716
python-slugify

0 commit comments

Comments
 (0)