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

docs: README is out of sync #89

Open
jdhoffa opened this issue Aug 19, 2024 · 0 comments
Open

docs: README is out of sync #89

jdhoffa opened this issue Aug 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jdhoffa
Copy link
Member

jdhoffa commented Aug 19, 2024

workflow.pacta/README.md

Lines 54 to 58 in 03d6c13

* `PACTA_DATA_DIR`: (default `/mnt/pacta-data`) Path where PACTA-data is located.
Can be set to an output directory from `workflow.data.preparation`.
* `ANALYSIS_OUTPUT_DIR`: (default `/mnt/analysis_output_dir`) Path where output files from the workflow will be written.
* `PORTFOLIO_DIR`: (default `/mnt/portfolios`) Path where Portfolio CSV files are stored.
* `LOG_LEVEL`: (default `INFO`) Controls verbosity of logging. Accepts standard `log4j` levels (UPPERCASE).

The .env file that I have and use for testing is something like:

data_dir="/PATH/TO/pacta-data/2023Q4"
analysis_output_dir="/PATH/TO/test_outputs"
input_dir="/PATH/TO/workflow.pacta/portfolios"

however, the README suggests I need variables like PACTA_DATA_DIR etc.

@jdhoffa jdhoffa added the documentation Improvements or additions to documentation label Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant