publicdata/j40-cejst-2
2
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-10-20 23:23:51 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add translations for repo documents (#281)

Browse source 
* WIP README improvements

* Add translations for some core open source process files

This addresses #37. Note that these translations were requested from the
State Dept a few weeks ago, so they don't have some of the latest
updates to content from recent PRs. We will need to come up with a good
proces for keeping both sets of docs up to date as we make changes.

Co-authored-by: Shelby Switzer <shelby.switzer@cms.hhs.gov>
This commit is contained in:
Shelby Switzer 2021-07-01 13:48:03 -04:00 • committed by GitHub
commit 774fe2d522
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 173 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
score/README.md
View file

@ -4,17 +4,17 @@
We use Docker to install the necessary libraries in a container that can be run in any operating system.
To build the docker container the first time, make sure you're in the root directory of the repository and run `docker-compose build`
To build the docker container the first time, make sure you have Docker running on your machine and that you're in the root directory of the repository. Then run `docker-compose build`.
Then run commands, opening a new terminal window or tab:
You can then run the following commands. You probably want to run these in a new terminal tab or window, because they may take a long time to run, especially the last one that generates the census data.
- Get help: `docker run --rm -it j40_score /bin/sh -c "python3 application.py" python3 application.py --help"`
- Clean up the data directories: `docker run --rm -it j40_score /bin/sh -c "python3 application.py data-cleanup"`
- Generate census data: `docker run --rm -it j40_score /bin/sh -c "python3 application.py census-data-download"`
- Generate census data (this may take 2-3 hours): `docker run --rm -it j40_score /bin/sh -c "python3 application.py census-data-download"`
## Log visualization
If you want to visualize logs, the following temporary workaround can be used:
If you want to visualize logs while running a command, the following temporary workaround can be used:
- Run `docker-compose up` on the root of the repo
- Open a new tab on your terminal
@ -22,7 +22,7 @@ If you want to visualize logs, the following temporary workaround can be used:
## Local development
You can run the Python code locally to develop, using Poetry. However, to generate the census data you will need the [GDAL library](https://github.com/OSGeo/gdal) installed locally. Also to generate tiles for a local map, you will need [Mapbox tippeanoe](https://github.com/mapbox/tippecanoe)
You can run the Python code locally without Docker to develop, using Poetry. However, to generate the census data you will need the [GDAL library](https://github.com/OSGeo/gdal) installed locally. Also to generate tiles for a local map, you will need [Mapbox tippeanoe](https://github.com/mapbox/tippecanoe)
- Start a terminal
- Make sure you have Python 3.9 installed: `python -V` or `python3 -V`