acl anthology
1.0.0
Ce référentiel contient:
La maison officielle de ce référentiel est https://github.com/acl-org/acl-anthology.
Veuillez consulter la lecture séparée du package Python pour des informations détaillées.
Ce sont des instructions de base sur la génération du site Web d'anthologie ACL comme on le voit sur https://aclanthology.org/.
Pour construire le site Web de l'anthologie, vous aurez besoin:
bin/requirements.txt ; Pour installer, exécutez pip -r bin/requirements.txtlibyaml-dev et Cython avant de courir, make la première fois, la bibliothèque Libyaml C sera utilisée à la place d'une implémentation Python, accélérant la version.Il y a une action GitHub Action effectuant un déploiement directement à partir de GitHub. Pour l'utiliser, vous devez définir cette variable dans vos paramètres de référentiel (interface Web: paramètres -> secrets):
PUBLISH_SSH_KEY : la clé secrète au format PEM standard pour l'authentification (sans phrase de passe) GitHub construire et déployer automatiquement le maître actuel chaque fois que la branche maître change. Cela se fait via la cible upload dans le makefile.
Clone le repo anthologie de votre machine locale:
$ git clone https://github.com/acl-org/acl-anthology À condition que vous ayez correctement installé toutes les exigences, la création du site Web devrait être aussi simple que la make du répertoire auquel vous avez cloné le repo.
Le site Web entièrement généré sera en build/anthology par la suite. Si des erreurs se produisent au cours de cette étape, vous pouvez consulter la lecture détaillée pour plus d'informations sur les étapes individuelles effectuées pour construire le site. Vous pouvez voir le site Web résultant en lançant un serveur Web local avec make serve , qui le servira à http: // localhost: 8000.
Notez que la construction du site Web est un processus assez à forte intensité de ressources; En particulier la dernière étape, invoquant Hugo, utilise environ 18 gb de mémoire système. La construction de l'anthologie prend environ 10 minutes sur un ordinateur portable avec un SSD.
( Remarque: Cela ne signifie pas que vous avez besoin de cette quantité de RAM dans votre système; en fait, le site Web s'accumule bien sur un ordinateur portable avec 8 Go de RAM. Le système pourrait temporairement ralentir en raison de l'échange, cependant. Le chiffre d'env. 18 Go est l'utilisation maximale de la RAM signalée lors de l'exécution hugo --minify --stepAnalysis .)
L'anthologie peut être visualisée localement en exécutant hugo server dans le répertoire hugo/ . Notez qu'il reconstruit le site et prend donc environ une minute pour commencer.
Tout d'abord, la création d'un miroir est lente et souligne l'infrastructure ACL Anthology car lors de la configuration initiale, vous devez télécharger chaque fichier de l'anthologie du serveur Web officiel. Cela peut prendre jusqu'à 8 heures, quelle que soit la vitesse à laquelle votre connexion est. Alors s'il vous plaît, ne jouez pas avec ça juste pour le plaisir.
Si vous souhaitez héberger un miroir, vous devez définir deux variables d'environnement:
ANTHOLOGY_PREFIX La préfixe HTTP Votre miroir sera accessible sous EG https://example.com/my-awesome-mirror ou http://aclanthology.lst.uni-saarland.de (remarquez qu'il n'y a pas de slash à la fin!)ANTHOLOGYFILES le répertoire sous quels papiers, pièces jointes, etc. résideront sur votre serveur Web. Ce répertoire doit être lisible par votre serveur Web (évidemment) mais ne devrait pas être un sous-répertoire du répertoire Mirror Anthology. Avec ces variables définies, vous exécutez make pour créer les pages et make mirror pour refléter tous les fichiers supplémentaires dans le répertoire Build / Anthology-Files. Si vous avez déjà créé un miroir, il ne téléchargera que les fichiers manquants.
Si vous souhaitez refléter les papiers mais pas tous les pièces jointes, vous pouvez make mirror-no-attachments à la place.
Vous avez ensuite renseigner la build/website/ répertoire de votre serveur Web ou, si vous servez le miroir dans un sous-répertoire FOO , vous Mirror build/website/FOO . Le répertoire build/anthology-files doit être RSYNC-ED au répertoire ANTHOLOGYFILES de votre serveur Web.
Comme vous voulez probablement garder le miroir à jour, vous pouvez modifier le script shell bin/acl-mirror-cronjob.sh à vos besoins.
Vous aurez besoin de ce logiciel sur le serveur
Si vous souhaitez que le processus de construction soit rapide, installez cython3 et libyaml-dev (voir ci-dessus).
Notez que la génération de l'anthologie prend un peu de RAM, alors assurez-vous qu'elle est disponible sur votre machine.
Si vous souhaitez contribuer à l'anthologie ACL, veuillez jeter un œil:
Ce dépôt était à l'origine Wing-NUS / ACL et a été transféré à ACL-Org au 5 juin 2017.
Le code de construction de l'anthologie ACL est distribué sous la licence Apache, v2.0.
