该存储库包含:
该存储库的官方住所是https://github.com/acl-org/acl-anthology。
有关详细信息,请参阅单独的读书文件以获取Python软件包。
这些是在https://aclanthology.org/上看到的有关生成ACL选集网站的基本说明。
要构建选集网站,您将需要:
bin/requirements.txt
中列出的python软件包;要安装,运行pip -r bin/requirements.txt
make
之前安装libyaml-dev
和Cython
,则将使用Libyaml C库代替Python实现,从而加快了构建。直接从Github执行部署的GitHub动作动作。要使用此功能,您需要在存储库设置(Web界面:设置 - >秘密)中定义此变量:
PUBLISH_SSH_KEY
:标准PEM格式的秘密键用于身份验证(无密码)然后,每当主分支更改时,GitHub将自动构建和部署当前主机。这是通过makefile中的upload
目标完成的。
克隆您本地机器的选集回购:
$ git clone https://github.com/acl-org/acl-anthology
只要您已经正确安装了所有要求,构建网站应该是从克隆回购的目录中简单运行的make
。
完整生成的网站之后将在build/anthology
集中进行。如果在此步骤中发生任何错误,您可以咨询详细的读书文件,以获取有关为构建网站执行的各个步骤的更多信息。您可以通过启动使用make serve
本地Web服务器来查看所得网站,该网站将在http:// localhost:8000上提供服务。
请注意,构建网站是一个相当大的资源密集过程。尤其是援引雨果的最后一步使用了大约18 〜GB的系统内存。在带有SSD的笔记本电脑上建造大约10分钟的选集。
(注意:这并不意味着您需要系统中的这一数量的RAM;实际上,该网站在带有8 GB RAM的笔记本电脑上构建良好。但是,系统可能由于交换而暂时放慢,但是大约。 18 GB是在运行hugo --minify --stepAnalysis
。)
可以通过在hugo/
Directory中运行hugo server
在本地查看选集。请注意,它可以重建网站,因此需要大约一分钟的时间才能开始。
首先,创建镜子很慢,强调ACL选集基础架构,因为在初始设置中,您必须从官方Web服务器下载选集的每个文件。无论您的连接速度多快,最多可能需要8个小时。因此,请不要为了娱乐而玩这个。
如果要托管镜子,则必须设置两个环境变量:
ANTHOLOGY_PREFIX
http前缀您的镜子将在例如https://example.com/my-awsome-mirror或http://aclanthology.lst.lst.uni-saarland.de(请注意,最后都没有Slash!)ANTHOLOGYFILES
将文件,附件等居住在您的网络服务器上的目录。该目录需要由您的网络服务器可读(显然),但不应是选集镜像目录的子目录。设置这些变量,您可以make
以创建页面并make mirror
,以将所有其他文件镜像构建/选集文件目录。如果您之前创建了镜像,它将仅下载丢失的文件。
如果您想镜像纸,但不是全部附件,则可以运行make mirror-no-attachments
。
然后,您将build/website/
目录与Web服务器联系起来,或者,如果您将镜像在子目录FOO
中提供镜子,则镜像build/website/FOO
。 build/anthology-files
目录需要与Web服务器的ANTHOLOGYFILES
目录进行rsync-ed。
由于您可能想保持镜像的最新状态,因此您可以根据需要修改Shell脚本bin/acl-mirror-cronjob.sh
。
您将在服务器上需要此软件
如果您希望构建过程快速,请安装cython3
和libyaml-dev
(请参见上文)。
请注意,生成选集需要大量RAM,因此请确保它在计算机上可用。
如果您想为ACL选集做出贡献,请查看:
该仓库最初是翼/ACL,截至2017年6月5日已转移到ACL-ORG。
构建ACL选集的代码是根据Apache许可证v2.0分发的。