acl anthology Download - acl anthology Quellcode herunterladen

acl anthology

Anderer Quellcode

1.0.0

Herunterladen

ACL -Anthologie

Dieses Repository enthält:

Metadaten für alle Artikel, Autoren und Veranstaltungsorte auf der Website der ACL Anthologie.
Code und Anweisungen zum Generieren der Website.
Ein Python -Paket zum Zugriff auf die Metadaten , die ebenfalls auf PYPI erhältlich ist.

Die offizielle Heimat dieses Repositorys ist https://github.com/acl-org/acl-anthology.

Verwenden des ACL-Anthologie-Py-Python-Pakets

Weitere Informationen finden Sie in der separaten Readme für das Python -Paket.

Generierung der Anthologie -Website generieren

Dies sind grundlegende Anweisungen zur Generierung der ACL -Anthologie -Website, die unter https://aclanthology.org/ zu sehen sind.

Voraussetzungen

Um die Anthologie -Website aufzubauen, benötigen Sie:

Python 3,8 oder höher
Python -Pakete, die in bin/requirements.txt aufgeführt sind.txt; Ausführen pip -r bin/requirements.txt ausführen, um zu installieren
Hugo 0,58.3 oder höher (kann direkt von ihrem Repo heruntergeladen werden; Die erweiterte Version ist erforderlich!)
Bibutils zum Erstellen von Nicht-Bibtex-Zitierformaten (nicht ausschließlich zum Erstellen der Website erforderlich, aber ohne sie müssen Sie die Build-Schritte manuell aufrufen, wie sie in der detaillierten Readme ausgelegt sind)
Optional : Wenn Sie libyaml-dev und Cython vor dem make installieren, wird die Biyaml C-Bibliothek anstelle einer Python-Implementierung verwendet, wodurch der Build beschleunigt wird.

Erstellen und Einsatz mit GitHub

Es gibt eine GitHub -Aktionsaktaktion, die die Bereitstellung direkt von GitHub ausführt. Um dies zu verwenden, müssen Sie diese Variable in Ihren Repository -Einstellungen definieren (Webschnittstelle: Einstellungen -> Geheimnisse):

PUBLISH_SSH_KEY : Der geheime Schlüssel im Standard -PEM -Format zur Authentifizierung (ohne Passphrase)

GitHub erstellt und bereitet dann den aktuellen Master automatisch, wenn sich der Master -Zweig ändert. Dies geschieht über das upload -Ziel im Makefile.

Klonen

Klonen Sie das Anthologie -Repo auf Ihre lokale Maschine:

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

Erzeugen

Vorausgesetzt, Sie haben alle Anforderungen korrekt installiert, das Erstellen der Website sollte so einfach aus dem Verzeichnis, auf das Sie das Repo kloniert haben, so einfach make werden.

Die vollständig generierte Website befindet sich anschließend in build/anthology . Wenn in diesem Schritt Fehler auftreten, können Sie die detaillierte ReadMe für weitere Informationen zu den einzelnen Schritten zum Erstellen der Website konsultieren. Sie können die resultierende Website sehen, indem Sie einen lokalen Webserver mit make serve starten, der sie unter http: // localhost: 8000 serviert.

Beachten Sie, dass das Erstellen der Website ein ressourcenintensiver Prozess ist. Insbesondere der letzte Schritt, der Hugo aufgerufen hat, verwendet etwa 18 ~ GB Systemspeicher. Der Bau der Anthologie dauert ungefähr 10 Minuten auf einem Laptop mit einer SSD.

( Hinweis: Dies bedeutet nicht , dass Sie diese Menge an RAM in Ihrem System benötigen. Tatsächlich baut die Website auf einem Laptop mit 8 GB RAM gut auf. Das System kann jedoch aufgrund des Austauschs vorübergehend langsamer werden. Die Zahl von ca. 18 GB ist die maximale RAM -Verwendung, die beim Ausführen hugo --minify --stepAnalysis angegeben wird.)

Die Anthologie kann lokal durch Ausführen von hugo server im hugo/ Verzeichnis betrachtet werden. Beachten Sie, dass es die Website wieder aufgebaut hat und daher ungefähr eine Minute dauert, um zu beginnen.

Hosting eines Spiegels der ACL -Anthologie

Erstens ist das Erstellen eines Spiegels langsam und betont die ACL -Anthologie -Infrastruktur, da Sie beim ersten Setup jede einzelne Datei der Anthologie vom offiziellen Webserver herunterladen müssen. Dies kann bis zu 8 Stunden dauern, egal wie schnell Ihre Verbindung ist. Also bitte nicht mit diesem Spaß herumspielen.

Wenn Sie einen Spiegel hosten möchten, müssen Sie zwei Umgebungsvariablen festlegen:

ANTHOLOGY_PREFIX Der Http-Präfix Ihr Spiegel ist unter eg https://example.com/my-awesome-mirror oder http://aclanthology.lst.uni-saarland.de (Beachten Sie, dass es am Ende keine Aufnahme gibt!)
ANTHOLOGYFILES das Verzeichnis, in dem sich Papiere, Anhänge usw. auf Ihrem Webserver befinden. Dieses Verzeichnis muss (offensichtlich) von Ihrem Webserver lesbar sein, sollte jedoch kein Unterverzeichnis des Anthologie -Spiegelverzeichnisses sein.

Mit diesen Variablen werden Sie make , um die Seiten zu erstellen und make mirror um alle zusätzlichen Dateien in das Verzeichnis "Build/Anthology-Datei" zu spiegeln. Wenn Sie bereits einen Spiegel erstellt haben, werden die fehlenden Dateien nur heruntergeladen.

Wenn Sie die Papiere, aber nicht alle Anhänge spiegeln möchten, können Sie stattdessen make mirror-no-attachments .

Sie dann RSYNC den build/website/ Verzeichnis in Ihrem Webserver oder, wenn Sie den Spiegel in einem FOO dienen, spiegeln Sie build/website/FOO . Das Verzeichnis build/anthology-files muss in das Verzeichnis ANTHOLOGYFILES Ihres Webservers rundc-rediert werden.

Da Sie den Spiegel wahrscheinlich auf dem neuesten Stand halten möchten, können Sie den Shell-Skript bin/acl-mirror-cronjob.sh an Ihre Anforderungen ändern.

Sie benötigen diese Software auf dem Server