diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f5434c --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +

Instructions

+ +Installation: +
  • Set up a virtual environment: `equity_toolkit` +
  • `conda env create -f env.yaml` +
  • `conda activate equity_tookit` + +File Prep: +
  • Place input csv file in `inputs` folder. +
  • Update `config` file with parameters. + +Run App: +
  • `python app.py` +
  • Navigate to local browser: http://127.0.0.1:8050/ + +Run Model: +```import yaml +import model + +with open('config.yaml') as f: + config = yaml.safe_load(f) + +model = model.Model(config) + +df_prep, tbl = model.prep() + +df_result = model.analysis(df_prep.copy(), tbl) +``` + +#to do, add legalese +#add api reference +#add use case +#add a notebooks file