acl anthology

Antología ACL

Este repositorio contiene:

• Metadatos para todos los documentos, autores y lugares en el sitio web de ACL Anthology.
• Código e instrucciones para generar el sitio web.
• Un paquete Python para acceder a los metadatos , también disponibles en PYPI.

El hogar oficial de este repositorio es https://github.com/acl-org/acl-anthology.

Uso del paquete ACL-Anthology-Py Python

Consulte el ReadMe separado para el paquete Python para obtener información detallada.

Generando el sitio web de antología

Estas son instrucciones básicas para generar el sitio web de ACL Anthology como se ve en https://aclanthology.org/.

Requisitos previos

Para construir el sitio web de antología, necesitará:

• Python 3.8 o superior
• Paquetes de Python enumerados en bin/requirements.txt ; Para instalar, ejecute pip -r bin/requirements.txt
• Hugo 0.58.3 o superior (se puede descargar directamente de su repositorio; ¡se requiere la versión extendida !)
• Bibutils para crear formatos de cita no bibtex (no se requieren estrictamente para construir el sitio web, pero sin ellos necesita invocar los pasos de compilación manualmente como se establecen en el readme detallado)
• Opcional : si instala libyaml-dev y Cython antes de ejecutar make la primera vez, la biblioteca Libyaml C se usará en lugar de una implementación de Python, acelerando la compilación.

Construcción y despliegue con GitHub

Hay una acción de GitHub Action que realiza implementación directamente desde GitHub. Para usar esto, debe definir esta variable en la configuración de su repositorio (interfaz web: configuración -> secretos):

• PUBLISH_SSH_KEY : la clave secreta en formato PEM estándar para la autenticación (sin una frase)

GitHub construirá e implementará automáticamente el maestro actual cada vez que cambie la rama maestra. Esto se realiza a través del objetivo upload en Makefile.

Clonación

Clon el repositorio de antología a su máquina local:

$ git clone https://github.com/acl-org/acl-anthology

Generador

Siempre que haya instalado correctamente todos los requisitos, construir el sitio web debe ser tan simple en ejecución make el directorio al que clonó el repositorio.

El sitio web totalmente generado estará en build/anthology posterior. Si ocurren errores durante este paso, puede consultar el ReadMe detallado para obtener más información sobre los pasos individuales realizados para construir el Sitio. Puede ver el sitio web resultante lanzando un servidor web local con make serve , que lo servirá en http: // localhost: 8000.

Tenga en cuenta que construir el sitio web es un proceso bastante intensivo en recursos; Particularmente el último paso, invocar a Hugo, usa aproximadamente 18 ~ GB de memoria del sistema. Construir la antología lleva unos 10 minutos en una computadora portátil con un SSD.

( Nota: Esto no significa que necesite esta cantidad de RAM en su sistema; de hecho, el sitio web se acumula bien en una computadora portátil con 8 GB de RAM. El sistema podría disminuir temporalmente debido al intercambio, sin embargo. La cifra de aprox. 18 GB es el uso máximo de RAM informado cuando se ejecuta hugo --minify --stepAnalysis .)

La antología se puede ver localmente ejecutando hugo server en el directorio hugo/ . Tenga en cuenta que reconstruye el sitio y, por lo tanto, tarda aproximadamente un minuto en comenzar.

Organizar un espejo de la antología ACL

Primero, crear un espejo es lento y enfatiza la infraestructura de antología ACL porque en la configuración inicial tiene que descargar cada archivo de la antología del servidor web oficial. Esto puede llevar hasta 8 horas, sin importar cuán rápido sea su conexión. Así que por favor no juegues con esto solo por diversión.

Si desea alojar un espejo, debe establecer dos variables de entorno:

• ANTHOLOGY_PREFIX El prefijo http su espejo se puede accesible bajo, por ejemplo, https://example.com/my-awesome-mirror o http://aclanthology.lst.uni-saarland.de (¡Observe que no hay basura al final!)
• ANTHOLOGYFILES el directorio bajo el cual los documentos, los archivos adjuntos, etc. residirán en su servidor web. Este directorio debe ser legible por su servidor web (obviamente), pero no debe ser un subdirectorio del directorio de espejo antología.

Con estas variables establecidas, se make para crear las páginas y make mirror para reflejar todos los archivos adicionales en el directorio de compilación/antología. Si ya creó un espejo, solo descargará los archivos que faltan.

Si desea reflejar los papeles pero no todos los archivos adjuntos, puede ejecutar make mirror-no-attachments en su lugar.

Luego, usted es el directorio build/website/ a su servidor web o, si sirve el espejo en un subdirectorio FOO , refleja build/website/FOO . El directorio build/anthology-files debe ser RSYNC-ed para el directorio ANTHOLOGYFILES de su servidor web.

Como probablemente desee mantener el espejo actualizado, puede modificar el script bin/acl-mirror-cronjob.sh a sus necesidades.

Necesitará este software en el servidor

• rsync
• git
• python3
• Hugo> 0.58
• python3-hvenv

Si desea que el proceso de compilación sea rápido, instale cython3 y libyaml-dev (ver arriba).

Tenga en cuenta que generar la antología requiere bastante RAM, así que asegúrese de que esté disponible en su máquina.

Que contribuye

Si desea contribuir a la antología ACL, eche un vistazo a:

• Nuestra página de problemas de Github
• El ReadMe detallado que contiene información más profunda sobre la generación y la modificación del sitio web.

Historia

Este repositorio fue originalmente Wing-Nus/ACL y ha sido transferido a ACL-ORG a partir del 5 de junio de 2017.

Licencia

El código para construir la antología ACL se distribuye bajo la licencia Apache, v2.0.