Merge pull request #343 from PSLmodels/rm-gh-wf-test

Remove 'make test' logic from .github/workflows

.github/workflows/pr.yml

@@ -15,23 +15,3 @@ jobs:
       - uses: psf/black@stable
         with:
           options: ". -l 79 --check"
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.11
-      - name: Install dependencies
-        run: make install
-        env:
-          POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN: ${{ secrets.POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN}}
-          PSL_TAX_MICRODATA_RELEASE_AUTH_TOKEN: ${{ secrets.PSL_TAX_MICRODATA_RELEASE_AUTH_TOKEN}}
-      - name: Generate tmd files
-        run: make tmd_files
-      - name: Run tests
-        run: make test
-      - name: Test documentation builds
-        run: make documentation

.github/workflows/push.yml

@@ -18,29 +18,3 @@ jobs:
       - uses: psf/black@stable
         with:
           options: ". -l 79 --check"
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.11
-      - name: Install dependencies
-        run: make install
-        env:
-          POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN: ${{ secrets.POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN}}
-          PSL_TAX_MICRODATA_RELEASE_AUTH_TOKEN: ${{ secrets.PSL_TAX_MICRODATA_RELEASE_AUTH_TOKEN}}
-      - name: Generate tmd files
-        run: make tmd_files
-      - name: Run tests
-        run: make test
-      - name: Build documentation
-        run: make documentation
-      - name: Deploy documentation
-        uses: JamesIves/github-pages-deploy-action@releases/v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages
-          folder: docs/book/_build/html

Makefile

@@ -1,7 +1,6 @@
 .PHONY=install
 install:
 	pip install -e .
-	python tmd/download_prerequisites.py
 
 .PHONY=clean
 clean:
@@ -61,10 +60,6 @@ data: install tmd_files test
 format:
 	black . -l 79
 
-.PHONY=documentation
-documentation:
-	jb build docs/book
-
 .PHONY=reweighting-visualisation
 reweighting-visualisation:
 	tensorboard --logdir=tmd/storage/output/reweighting

README.md

@@ -8,15 +8,18 @@ development will proceed in several phases.
 
 ## Usage instructions
 
-To generate the microdata files:
+In order to use the code in this repository, you need to license the
+2015 PUF from IRS/SOI.  Once you have done that, you will have two
+CSV-formatted files from IRS/SOI: `puf_2015.csv` and
+`demographics_2015.csv`.
 
-1. Run `export POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN=***`
-2. Run `export PSL_TAX_MICRODATA_RELEASE_AUTH_TOKEN=***`
-3. Run `make data`
+To generate the TMD files from the PUF files, do this:
+
+1. Copy the two 2015 PUF files to the `tmd/storage/input` folder
+2. Run `make data` in the repository's top-level folder
 
 The `make data` command creates and tests the three `tmd*csv*` data
-files, which are located in the `tmd/storage/output` folder.  The two
-tokens can be obtained from [Don Boyd](mailto:[email protected]).
+files, which are located in the `tmd/storage/output` folder.
 
 ## Examination results