mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-20 08:41:26 -08:00
Add translations for repo documents (#281)
* 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:
parent
602c3c2fbc
commit
774fe2d522
11 changed files with 173 additions and 6 deletions
16
CODE_OF_CONDUCT-es.md
Normal file
16
CODE_OF_CONDUCT-es.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Código de conducta del colaborador
|
||||
|
||||
*[Read this in English!](CODE_OF_CONDUCT.md)*
|
||||
|
||||
Como colaboradores y mantenedores de este proyecto, nos comprometemos a respetar a todas las personas que contribuyen con informes de problemas, solicitudes de funciones, actualización de documentación, solicitudes de incorporación de cambios o revisiones, y otras actividades.
|
||||
|
||||
Nuestro compromiso es que no exista acoso para los participantes en este proyecto, sin considerar su nivel de experiencia, género, identidad y expresión de género, orientación sexual, discapacidad, aspecto personal, tamaño corporal, raza, etnia, edad o religión.
|
||||
|
||||
Algunos ejemplos de comportamiento inaceptable de los participantes son: uso de lenguaje o imágenes sexuales, comentarios despectivos o ataques personales, troleo, acoso público o privado, insultos u otra conducta poco profesional.
|
||||
|
||||
Los mantenedores del proyecto tienen el derecho y la obligación de eliminar, editar o rechazar comentarios, confirmaciones, código, modificaciones de wiki, problemas u otras colaboraciones que no cumplan con este Código de conducta.
|
||||
|
||||
Los casos de abuso, acoso o de otro comportamiento inaceptable se pueden denunciar abriendo un problema o contactando con uno o más de los mantenedores del proyecto en justice40open@usds.gov.
|
||||
|
||||
Este Código de conducta es una adaptación de la versión 1.0.0 del Convenio del colaborador ([Contributor Covenant](contributor-covenant.org), *en inglés*) disponible en el sitio http://contributor-covenant.org/version/1/0/0/ *(en inglés)*.
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
# Contributor Code of Conduct
|
||||
|
||||
*[¡Lea esto en español!](CODE_OF_CONDUCT-es.md)*
|
||||
|
||||
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
|
||||
|
||||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
|
||||
|
|
44
CONTRIBUTING-es.md
Normal file
44
CONTRIBUTING-es.md
Normal file
|
@ -0,0 +1,44 @@
|
|||
# Colaboraciones con la herramienta Justice40
|
||||
|
||||
*[Read this in English!](CONTRIBUTING.md)*
|
||||
|
||||
🎉 Primeramente, agradecemos el tiempo que dedica a su colaboración. 🎉
|
||||
|
||||
Siga las instrucciones siguientes para colaborar con la herramienta Justice40 que reside en este repositorio.
|
||||
|
||||
Antes de hacer su aportación, recomendamos que lea además nuestros archivos [LICENCIA](LICENSE-es.md) y [LÉAME](README-es.md), que también se incluyen aquí. Si el contenido de este repositorio no responde a sus preguntas, no dude en [contactar con nosotros](mailto:justice40open@usds.gov).
|
||||
|
||||
## Dominio público
|
||||
Este proyecto es de dominio público en los Estados Unidos, y se renuncia a los derechos de autor y derechos conexos sobre la obra en todo el mundo por medio de la [CC0 1.0 Universal, Dedicación de dominio público](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||
|
||||
Todas las aportaciones que se hagan a este proyecto se divulgarán conforme a la dedicación CC0. Al presentar una solicitud de incorporación de cambios, usted acepta cumplir con esta renuncia a los intereses de derechos de autor.
|
||||
|
||||
## ¿Cómo puedo colaborar?
|
||||
|
||||
### Informe de un error
|
||||
Si cree que encontró un error en la herramienta Justice40, consulte nuestra lista de problemas en GitHub para saber si ya se abrió uno similar.
|
||||
|
||||
Cuando informe de un error, siga estas instrucciones:
|
||||
* **Use la plantilla de informe de error**, Bug Report ([aquí](https://github.com/usds/justice40-tool/issues/new/choose), para comunicar el problema. La plantilla se llena con la información adecuada.
|
||||
* **Use un título claro y descriptivo del problema** para definirlo.
|
||||
* **Describa los pasos exactos para reproducir el problema** con todos los detalles posibles. Por ejemplo, comience con una explicación de cómo llegó a la página donde encontró el error.
|
||||
* **Describa el comportamiento que observó después de seguir esos pasos** e indique exactamente cuál es el problema que causa ese comportamiento.
|
||||
* **Explique cuál era el comportamiento que esperaba ver y por qué.**
|
||||
* **Incluya capturas de pantalla y GIF animados** si es posible, en los que se vean los pasos descritos que siguió y muestren claramente el problema.
|
||||
* **Si el problema no lo desencadenó una acción específica**, describa lo que estaba haciendo cuando se presentó el problema.
|
||||
|
||||
### Sugiera un mejoramiento
|
||||
Si desea sugerir un cambio, solicitar una función o tratar un asunto, pero no tiene el lenguaje o el código específico para enviar su solicitud, puede abrir un problema en este repositorio.
|
||||
|
||||
Abra [aquí](https://github.com/usds/justice40-tool/issues/new/choose) un problema de tipo "Solicitud de función".
|
||||
|
||||
En el problema, describa la función que desea, por qué la necesita y cómo debería funcionar esta. Los integrantes del equipo responderán a este lo antes posible.
|
||||
|
||||
### Colaboraciones con código
|
||||
Si desea colaborar con alguna parte del código base, bifurque el repositorio siguiendo la [siguiente metodología de GitHub para hacer la bifurcación](https://docs.github.com/es/get-started/quickstart/fork-a-repo) *(en inglés)*. Luego, haga los cambios en el código de su propia copia del repositorio (incluya pruebas, si corresponde) y, por último, [envíe una solicitud para incorporar los cambios en el repositorio precedente](https://docs.github.com/es/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) *(en inglés)*. Para poder fusionar una solicitud de incorporación de cambios, las siguientes opciones en este repositorio deben estar habilitadas:
|
||||
|
||||
* No se permiten las fusiones al proyecto principal `main`; abra una solicitud de incorporación de cambios desde una rama.
|
||||
* Al menos un revisor autorizado debe aprobar la confirmación (en [CODEOWNERS](https://github.com/usds/justice40-tool/tree/main/.github/CODEOWNERS), en inglés, consulte la lista más reciente de estos revisores).
|
||||
* Todas las verificaciones de estado obligatorias deben ser aprobadas.
|
||||
Si hay un desacuerdo importante entre los integrantes del equipo, se organizará una reunión con el fin de determinar el plan de acción para la solicitud de incorporación de cambios.
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
# Contributing to the Justice40 Tool
|
||||
|
||||
*[¡Lea esto en español!](CONTRIBUTING-es.md)*
|
||||
|
||||
🎉 First off, thanks for taking the time to contribute! 🎉
|
||||
|
||||
The following is a set of guidelines for contributing to the Justice40 Tool that lives in this repository.
|
||||
|
|
31
LICENSE-es.md
Normal file
31
LICENSE-es.md
Normal file
|
@ -0,0 +1,31 @@
|
|||
# CC0 1.0 Universal
|
||||
|
||||
*[Read this in English!](LICENSE.md)*
|
||||
|
||||
CREATIVE COMMONS CORPORATION NO ES UN ESTUDIO DE ABOGADOS Y NO PRESTA SERVICIOS LEGALES. LA DISTRIBUCIÓN DE ESTE DOCUMENTO NO ESTABLECE UNA RELACIÓN CLIENTE-ABOGADO. CREATIVE COMMONS PROPORCIONA ESTA INFORMACIÓN "TAL CUAL". CREATIVE COMMONS NO OTORGA GARANTÍAS PARA EL USO DE ESTE DOCUMENTO O DE LA INFORMACIÓN O LAS OBRAS PREVISTAS A CONTINUACIÓN, Y EXCLUYE LA RESPONSABILIDAD POR LOS DAÑOS QUE SE DERIVEN DEL USO DE ESTE DOCUMENTO O DE LA INFORMACIÓN O LAS OBRAS QUE SE SEÑALAN MÁS ADELANTE.
|
||||
|
||||
### Declaración de propósito
|
||||
Las leyes de la mayoría de las jurisdicciones en todo el mundo confieren automáticamente los Derechos de Autor y Derechos Conexos (definidos más abajo) al creador y a los propietarios posteriores (en conjunto, un "propietario") de una obra original de autoría o una base de datos (individualmente, una "Obra").
|
||||
Ciertos propietarios desean renunciar permanentemente a los derechos sobre una Obra con el propósito de contribuir a un bien común de obras creativas, culturales y científicas ("Bien Común") en el que el público pueda, de manera segura y sin temor a reclamaciones de infracción posteriores, agregar, modificar, incorporar en otras obras, reutilizar y redistribuir con la mayor libertad posible, en cualquier forma y con cualquier propósito, incluidos, entre otros, fines comerciales. Estos propietarios pueden contribuir al Bien Común para promover el ideal de una cultura libre y la producción de otras obras creativas, culturales y científicas, o bien para ganar una reputación o para mayor distribución de su Obra en parte con el uso y el trabajo de otros.
|
||||
Por estos u otros propósitos y motivos, y sin ninguna expectativa de otra consideración o compensación, la persona que asocia una CC0 a una Obra (el "Afirmante"), en la medida en que él o ella sea el propietario o propietaria de los Derechos de Autor y los Derechos Conexos de la Obra, elige voluntariamente aplicar la CC0 a la Obra y distribuir públicamente la Obra conforme a sus términos, con conocimiento de sus Derechos de Autor y Derechos Conexos sobre la Obra y del significado y el efecto legal previsto de la CC0 sobre esos derechos.
|
||||
|
||||
1. **Derechos de autor y derechos conexos.** Una Obra que se ponga a disposición en virtud de una CC0 puede estar protegida por los derechos de autor o los derechos conexos ("Derechos de Autor y Derechos Conexos"). Los Derechos de Autor y Derechos Conexos incluyen, entre otros, los siguientes:
|
||||
i. el derecho a reproducir, adaptar, distribuir, interpretar, exhibir, comunicar y traducir una Obra;
|
||||
ii. los derechos morales que conservan los autores originales o los intérpretes;
|
||||
iii. los derechos de publicidad y de privacidad pertenecientes a la imagen o el parecido de una persona representada en una Obra;
|
||||
iv. los derechos de protección contra la competencia desleal en lo que se refiere a una Obra, sujetos a las limitaciones del párrafo 4(a), más abajo;
|
||||
v. los derechos que protegen la extracción, difusión, uso y reutilización de los datos en una Obra;
|
||||
vi. los derechos sobre las bases de datos (como los que surgen de la Directiva 96/9/CE del Parlamento Europeo y del Consejo del 11 de marzo de 1996 sobre la protección legal de bases de datos, y conforme a cualquier implementación nacional de estos, incluida toda enmienda o versión posterior de esa directiva); y
|
||||
vii. otros derechos similares, equivalentes o correspondientes en todo el mundo que se basen en leyes o tratados aplicables, y cualquier implementación nacional de estos.
|
||||
2. **Renuncia.** En la mayor medida posible de lo permitido por las leyes aplicables, pero sin contravenirlas, por este medio y de forma abierta, completa, permanente, irrevocable e incondicional, el Afirmante renuncia, abandona y rescinde todos los Derechos de Autor y Derechos Conexos del Afirmante y las reclamaciones y los derechos de acción afines, sean conocidos o desconocidos actualmente (incluidas las reclamaciones y los derechos de acción existentes y futuros), sobre la Obra (i) en todos los territorios del mundo; (ii) por la duración máxima prevista por la ley o el tratado aplicable (incluidas las extensiones de tiempo futuras); (iii) en cualquier medio actual o futuro y para cualquier número de copias; y (iv) para cualquier fin, incluidos, entre otros, fines comerciales, publicitarios y promocionales (la "Renuncia"). El Afirmante hace la Renuncia en beneficio de toda persona del público y en detrimento de los herederos y sucesores del Afirmante, con la intención plena de que esa Renuncia no estará sujeta a revocación, rescisión, cancelación, terminación o cualquier otra acción legal o equitativa que altere el disfrute tranquilo del público de la Obra según se contempla en la Declaración de Propósito expresa del Afirmante.
|
||||
3. **Alternativa de la licencia pública.** Si se concluye por algún motivo que una parte de la Renuncia no tiene validez legal o no tiene vigencia conforme a las leyes aplicables, la Renuncia se conservará en la máxima medida permitida teniendo en cuenta la Declaración de Propósito expresa del Afirmante. Además, en la medida en que se concluya lo anterior acerca de la Renuncia, por este medio, el Afirmante otorga a cada persona afectada una licencia sin derechos de autor, no transferible, sin sublicencias, no exclusiva, irrevocable e incondicional para ejercer los Derechos de Autor y Derechos Conexos del Afirmante sobre la Obra (i) en todos los territorios del mundo; (ii) por la duración máxima prevista por la ley o el tratado aplicable (incluidas las extensiones de tiempo futuras); (iii) en cualquier medio actual o futuro y para cualquier número de copias; y (iv) para cualquier fin, incluidos, entre otros, fines comerciales, publicitarios o promocionales (la "Licencia"). La Licencia se considerará vigente a partir de la fecha en que el Afirmante aplique la CC0 a la Obra. Si se concluye por algún motivo que una parte de la Licencia no tiene validez legal o no tiene vigencia conforme a las leyes aplicables, esa falta de validez o de vigencia no invalidará el resto de la Licencia, y, en ese caso, el Afirmante asegura por este medio que él o ella (i) no ejercerá ninguno de sus Derechos de Autor y Derechos Conexos que queden sobre la Obra; (ii) no hará valer ninguna reclamación ni derecho de acción afines con respecto a la Obra que sean contrarios en cualquier caso a la Declaración de Propósito expresa del Afirmante.
|
||||
4. **Limitaciones y descargos de responsabilidad.**
|
||||
|
||||
a. No se renuncia a ningún derecho sobre las marcas registradas o las patentes que retenga el Afirmante, ni se abandona, rescinde, autoriza o se ve afectado de otro modo por este documento.
|
||||
|
||||
b. El Afirmante ofrece la Obra tal cual y no hace ninguna declaración ni otorga garantías de ningún tipo en lo que se refiere a la Obra, sean expresas, implícitas, reglamentarias o de otro tipo, incluidas, entre otras, garantías de título, comerciabilidad, idoneidad para un fin particular, ausencia de infracciones o de defectos latentes o de otro tipo, precisión, o la presencia o ausencia de errores, sean o no sean detectables, todo en la máxima medida permisible conforme a la ley aplicable.
|
||||
|
||||
c. El Afirmante excluye la responsabilidad de los derechos de compensación de otras personas que se puedan aplicar a la Obra o a cualquier uso de esta, incluidos, entre otros, los Derechos de Autor y Derechos Conexos de cualquier persona sobre la Obra. Además, el Afirmante excluye la responsabilidad de obtener los consentimientos o permisos u otros derechos necesarios que se exijan para cualquier uso de la Obra.
|
||||
|
||||
d. El Afirmante entiende y reconoce que Creative Commons no es una parte en este documento y que no tiene ningún derecho u obligación con respecto a esta CC0 o al uso de la Obra.
|
||||
|
|
@ -1,5 +1,7 @@
|
|||
# CC0 1.0 Universal
|
||||
|
||||
*[¡Lea esto en español!](LICENSE-es.md)*
|
||||
|
||||
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER.
|
||||
|
||||
### Statement of Purpose
|
||||
|
|
23
MAINTAINERS-es.md
Normal file
23
MAINTAINERS-es.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# Mantenedores del proyecto Justice40
|
||||
|
||||
*[Read this in English!](MAINTAINERS.md)*
|
||||
|
||||
## Dirección del proyecto
|
||||
- Lucas Brown - lucasmbrown-usds
|
||||
|
||||
## Ingeniería
|
||||
(Consultar la lista definitiva en [archivo CODEOWNERS](./github/CODEOWNERS).
|
||||
- Shelby Switzer - switzersc-usds - dirección de ingeniería
|
||||
- Nat Hillard - NatHillardUSDS
|
||||
- Jorge Escobar - esfoobar-usds
|
||||
- Tom Nielsen - TomNUSDS
|
||||
- Gina Maini - ginabeena
|
||||
- Vim Shah - vim-usds
|
||||
|
||||
## Producto
|
||||
- Katherine Mlika - katherinedm-usds
|
||||
- Beth Mattern - BethMattern
|
||||
|
||||
## Diseño
|
||||
- Kameron Kerger - KameronKerger
|
||||
- Jane Lien - janelien
|
|
@ -1,4 +1,7 @@
|
|||
# Justice40 Project Maintainers
|
||||
|
||||
*[¡Lea esto en español!](MAINTAINERS-es.md)*
|
||||
|
||||
## Project Leadership
|
||||
- Lucas Brown - lucasmbrown-usds
|
||||
|
||||
|
|
43
README-es.md
Normal file
43
README-es.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
# Herramienta Justice40
|
||||
[](https://github.com/usds/justice40-tool/blob/main/LICENSE)
|
||||
|
||||
*[Read this in English!](README.md)*
|
||||
|
||||
Le damos la bienvenida a la comunidad de código abierto de Justice40. Este repositorio contiene el código, los procesos y la documentación que activa los datos y la tecnología de la Herramienta Justice40 para la Vigilancia del Clima y la Justicia Económica (CEJST, por sus siglas en inglés).
|
||||
|
||||
## Antecedentes
|
||||
En enero de 2021, una [orden ejecutiva](https://www.whitehouse.gov/briefing-room/presidential-actions/2021/01/27/executive-order-on-tackling-the-climate-crisis-at-home-and-abroad/) *(en inglés)* anunció la iniciativa Justice40 y la herramienta de vigilancia con el objetivo de presentar un producto mínimo viable (MVP, por sus siglas en inglés) de la herramienta para el 27 de julio de 2021. La herramienta incluirá mapas interactivos y la versión preliminar de un informe de evaluación para que, al asignar los beneficios de sus programas, las dependencias federales puedan dar prioridad a las comunidades más desatendidas y agobiadas.
|
||||
|
||||
## Equipo central
|
||||
El equipo central de Justice40 a cargo de la creación de esta herramienta consiste en un grupo pequeño de diseñadores, desarrolladores y coordinadores de productos del Servicio Digital de los EE. UU. en asociación con el Consejo de Calidad Ambiental (CEQ, por sus siglas en inglés).
|
||||
|
||||
En [MAINTAINERS-es.md](MAINTAINERS-es.md), se publica la lista actualizada de los integrantes del equipo central. La lista de los ingenieros del equipo central a cargo del mantenimiento del código en este repositorio se puede consultar en [.github/CODEOWNERS](.github/CODEOWNERS) *(en inglés)*.
|
||||
|
||||
## Comunidad
|
||||
En la realización de esta herramienta, el método de código abierto que usa el equipo de Justice40 se dirige primeramente a la comunidad. Consideramos que el software del gobierno se debería dar a conocer, y que se debe crear y autorizar de manera que cualquier persona pueda acceder al código, ejecutarlo sin necesidad de pagar a terceros ni de emplear software propietario, y usarlo como desee.
|
||||
|
||||
Sabemos que podemos aprender de comunidades muy distintas (incluidas las que usarán la herramienta o se verán afectadas por esta) que tienen gran experiencia en la ciencia o la tecnología de datos, o en el trabajo en favor del clima y de la justicia económica o ambiental. Nos dedicamos a crear foros para facilitar la conversación y los comentarios continuos con objeto de conformar el diseño y el desarrollo de la herramienta.
|
||||
|
||||
Asimismo, reconocemos que la generación de capacidad es indispensable para incluir a una comunidad diversa de código abierto. Estamos procurando usar lenguaje accesible, proporcionar documentación técnica y sobre procesos en varios idiomas, y ofrecer asistencia, sea directamente o en forma de chats de grupo y de capacitación, a los miembros de nuestra comunidad que poseen gran variedad de conocimientos y habilidades. Si tiene ideas acerca de cómo podemos mejorar o ampliar nuestro trabajo para generar capacidad y de métodos para atraer a los usuarios a nuestra comunidad, comuníquese con nosotros en el [Grupo de Google]((https://groups.google.com/u/4/g/justice40-open-source)) *(en inglés)* o por correo electrónico en justice40open@usds.gov.
|
||||
|
||||
### Chats de la comunidad
|
||||
Cada dos semanas, llevamos a cabo sesiones de chat para la comunidad de código abierto los lunes de 5 a 6 p. m. hora del Este. Nuestro [Grupo de Google](https://groups.google.com/u/4/g/justice40-open-source) *(en inglés)*, proporciona información acerca de los temas que se tratarán en esas sesiones y de cómo puede participar en estas.
|
||||
|
||||
Se invita a los miembros de la comunidad a informar de novedades o a proponer temas de conversación para los chats de la comunidad, por medio del Grupo de Google.
|
||||
|
||||
### Grupo de Google
|
||||
Nuestro [Grupo de Google](https://groups.google.com/u/4/g/justice40-open-source) *(en inglés)* está abierto a quienes deseen participar y comunicar ahí sus conocimientos o experiencias, y hacer preguntas al equipo central de Justice40 o a la comunidad en conjunto.
|
||||
|
||||
El equipo central usa el grupo para publicar la información más reciente sobre el programa y problemas técnicos y de datos. También comunica ahí la agenda y solicita la participación de la comunidad en el chat.
|
||||
|
||||
¿Tiene una pregunta y no sabe si debe plantearla aquí como un problema de GitHub o en el Grupo de Google? La regla general es que los problemas son para los temas que requieren acciones o procesos relacionados con la herramienta o los datos (por ejemplo, preguntas acerca de conjuntos específicos de datos en uso, o sugerencias para una nueva función de la herramienta), mientras que el Grupo de Google es para temas o preguntas más generales. Si está indeciso, use el Grupo de Google y hablaremos ahí antes de pasar su pregunta a GitHub, si corresponde.
|
||||
|
||||
## Colaboraciones
|
||||
Las colaboraciones son siempre bien recibidas. Nos agradan las aportaciones en forma de conversación sobre los temas de este repositorio y las solicitudes para incorporación de cambios en la documentación y el código.
|
||||
En [CONTRIBUTING-es.md](CONTRIBUTING-es.md), consulte la manera de empezar a participar.
|
||||
|
||||
## Glosario
|
||||
¿Tiene duda acerca de un término? ¿Encontró un acrónimo y no sabe a qué se refiere? Consulte [nuestro glosario](docs/glossary.md) *(en inglés)*.
|
||||
|
||||
## Comentarios
|
||||
Si tiene preguntas o comentarios, escríbanos a justice40open@usds.gov.
|
|
@ -1,7 +1,8 @@
|
|||
|
||||
# Justice40 Tool
|
||||
[](https://github.com/usds/justice40-tool/blob/main/LICENSE)
|
||||
|
||||
*[¡Lea esto en español!](README-es.md)*
|
||||
|
||||
Welcome to the Justice40 Open Source Community! This repo contains the code, processes, and documentation for the data and tech powering the Justice40 Climate and Economic Justice Screening Tool (CEJST).
|
||||
|
||||
## Background
|
||||
|
|
|
@ -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`
|
||||
|
|
Loading…
Add table
Reference in a new issue