Skip to content

Commit

Permalink
#85: Updates instructions in /externals/
Browse files Browse the repository at this point in the history
  • Loading branch information
snairdesai committed Jan 29, 2024
1 parent d1edcce commit 979aa11
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
4 changes: 2 additions & 2 deletions extensions/excel_tables/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
## Purpose and Usage
---

This directory includes code which can be used to construct and export table objects in `gentzkow/template` from an Excel format to publication-ready PDF outputs. Note that the contents of this directory are intended to serve as a minimal working example of the functionality of the core function underlying the conversion: `export_excel_tables()` in the `run_program.py` script in the `gslab_make` submodule.
This directory includes code which can be used to construct and export table objects in `gentzkow/template` from an Excel format to publication-ready PDF outputs. Note that the contents of this directory are intended to serve as a minimal working example of the functionality of the core function underlying the conversion: `export_excel_tables()` in the `run_program.py` script in the `gslab_make` submodule. For users on Windows machines, please ensure you construct the `conda` environment with the `pywin32` package installed (see `/setup/conda_env.yaml`).

The structure of subdirectories in `/extensions/excel_tables/` parallels that of the overall repository. Files in each submodule directory (e.g. `/extensions/excel_tables/analysis/` or `/extensions/excel_tables/paper_slides/`) should be copied to the main submodule directory (e.g. `~/analysis/` or `~/paper_slides/`).

Then executing make-scripts, for example with `python run_all.py`, will build outputs using the updated submodules from this `/extensions/` folder, rather than in the root directory.
Then executing make-scripts, for example with `python run_all.py`, will build outputs using the updated submodules from this `/extensions/` folder, rather than in the root directory. **Please note: this process will call Excel using your computer's native software. Be sure to save any open Excel sheets prior to running this code, as the application will exit and restart.**

---
## Procedure and Instructions
Expand Down
10 changes: 7 additions & 3 deletions setup/conda_env.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ dependencies:
- linearmodels
- pandas
- openpyxl
- pywin32 # This will only be installed on Windows machines, for Excel to PDF conversion.
# - julia
# For users of Windows machines, please uncomment the line below if you plan to use `export_excel_tables()` for Excel to PDF conversion.
# - pywin32

# - julia

# - pip
# - pip: # if there is a package available via pip but not with conda, can import like this:
# - pip: # if there is a package available via pip but not with conda, can import like this.

- r
# - r-yaml # import r packages by prepending with "r-"
# - r-nicheROVER
Expand Down

0 comments on commit 979aa11

Please sign in to comment.