acl anthology
1.0.0
このリポジトリには次のものが含まれています。
このリポジトリの公式ホームはhttps://github.com/acl-org/acl-anthologyです。
詳細については、Pythonパッケージの個別のREADMEをご覧ください。
これらは、https：//aclanthology.org/に見られるACLアンソロジーWebサイトの生成に関する基本的な指示です。
アンソロジーのウェブサイトを構築するには、次のことが必要です。
bin/requirements.txtにリストされているPythonパッケージ。インストールするには、 pip -r bin/requirements.txtを実行しますlibyaml-devとCythonインストールすると、初めての時間make 、Python実装の代わりにLibyaml Cライブラリが使用され、ビルドが高速化されます。GitHubから直接展開を実行するGitHubアクションアクションがあります。これを使用するには、リポジトリ設定でこの変数を定義する必要があります（Webインターフェイス：設定 - > secrets）：
PUBLISH_SSH_KEY ：認証用の標準PEM形式のシークレットキー（パスフレーズなし） GitHubは、マスターブランチが変更されるたびに、現在のマスターを自動的に構築および展開します。これは、MakeFileのuploadターゲットを介して行われます。
アンソロジーリポジトリをローカルマシンにクローンします。
$ git clone https://github.com/acl-org/acl-anthologyすべての要件を正しくインストールしていれば、Webサイトの構築は、リポジトリをクローンするディレクトリから簡単に実行makeれるようにする必要があります。
完全に生成されたウェブサイトは、その後build/anthologyになります。このステップでエラーが発生した場合は、サイトを構築するために実行された個々の手順の詳細については、詳細なREADMEを参照してください。 make serve備えたローカルWebサーバーを起動することで、結果のWebサイトを見ることができます。
Webサイトの構築は、非常にリソース集約的なプロセスであることに注意してください。特に最後のステップであるHugoの呼び出しは、システムメモリの約18〜GBを使用します。アンソロジーを構築するには、SSDを使用してラップトップで約10分かかります。
（注：これは、システムにこの量のRAMが必要なことを意味するものではありません。実際、Webサイトは8 GBのRAMを備えたラップトップで問題なく構築されています。ただし、スワッピングのためにシステムは一時的に遅くなる可能性があります。 18 GBはhugo --minify --stepAnalysis実行するときに報告された最大RAM使用量です。
アンソロジーは、 hugo/ Directoryでhugo server実行することでローカルに表示できます。サイトを再構築するため、開始に約1分かかることに注意してください。
まず、ミラーを作成することは遅く、ACLアンソロジーインフラストラクチャにストレスを与えます。最初のセットアップでは、公式のWebサーバーからアンソロジーのすべてのファイルをダウンロードする必要があります。接続がどれほど速くても、これには最大8時間かかる場合があります。だから、これを楽しみのためだけに遊んではいけません。
ミラーをホストする場合は、2つの環境変数を設定する必要があります。
ANTHOLOGY_PREFIX httpプレフィックスあなたのミラーは、例：https://example.com/my-awesome-mirrorまたはhttp://aclanthology.lst.uni-saarland.de（最後にスラッシュがないことに注意してください！）ANTHOLOGYFILES論文、添付ファイルなどがWebサーバーに存在するディレクトリをファイルします。このディレクトリは、（明らかに）Webサーバーが読みやすくする必要がありますが、アンソロジーミラーディレクトリのサブディレクトリであってはなりません。これらの変数を設定すると、 make実行してページを作成し、 make mirrorて、すべての追加ファイルをBuild/Anthology-Filesディレクトリにミラーリングします。既にミラーを作成した場合、欠落しているファイルのみをダウンロードします。
すべての添付ファイルではなく、論文をミラーリングしたい場合は、代わりにmake mirror-no-attachmentsを実行できます。
次に、 build/website/ディレクトリをWebサーバーにrsyncするか、サブディレクトリFOOでミラーを提供する場合は、 build/website/FOOミラーリングします。 build/anthology-filesディレクトリは、WebServerのANTHOLOGYFILESディレクトリにrsync-edする必要があります。
おそらくミラーを最新の状態に保ちたいので、シェルスクリプトbin/acl-mirror-cronjob.shニーズに合わせて変更できます。
サーバー上のこのソフトウェアが必要になります
ビルドプロセスを速くしたい場合は、 cython3とlibyaml-devをインストールします（上記参照）。
アンソロジーを生成するにはかなりのRAMが必要であるため、マシンで使用できることを確認してください。
ACLアンソロジーに貢献したい場合は、次をご覧ください。
このレポはもともとWing-Nus/ACLであり、2017年6月5日現在、ACL-ORGに転送されました。
ACLアンソロジーを構築するためのコードは、Apacheライセンスv2.0の下で配布されています。
