Watch a tutorial video to set up the Google Colab version of the code here.
This Github contains a folder for each base case, and one for the benchmark cases. Each folder contains the code in a .ipynb file, the template text for each cost category in the 'Originals' folder, and other files required for the latex document to compile. To generate a report:
-
Download the code notebook .ipynb file or save a copy into google colab (search google colab, then file/upload notebook/ Github/ search for this repo using the url and select a code from the MFE, IFE etc.) currently running from google colab is recommended. If you decide to run the code locally, git handling code and file locations may be different, depending on your OS and environment.
-
Open the Overleaf link.
-
Here there are folders for each costing case. Select one, inside there are 'Originals', 'Modified', 'Costing_ARPA-E_x_Modified', 'Costing_ARPA-E_x_Originals' and others. To compile a report with template folders, run 'Costing_ARPA-E_x_Originals'. To edit text, edit files in 'Originals'. Edits made to files in the 'Modified' folder will be overwritten when the code is run.
-
Become a Github collaborator and generate a PAT (ensure it has 'repo' access).
-
Input PAT into first cell of code.
-
Enter inputs in the code, and run all cells. This will overwrite 'originals' templates.
-
Go to overleaf and 'pull' from github into overleaf.
-
Compile the 'Costing_ARPA-E_x_Modified' .tex file for the corresponding case.
-
A report should have compiled with the placeholder variables replaced.
-
To edit the text, edit the 'originals' .tex files corresponding to the cost category you would like to edit, in the case folder you are working on.
-
Go to 'Github' on the left tab, and 'push'.
-
Restart code (in colab go 'Runtime/Disconnect and delete runtime' then 'run all'), and repeat steps 3-6.