跳到内容

acl-org/acl-人类学

存储库文件导航

ACL选集

ACL精选网站 GitHub贡献者 良好的第一个项目问题 许可证 PyPI上的acl-anthology-py

此存储库包含:

此存储库的官方主页是https://github.com/acl-org/acl-anthology网站.

使用acl-anthology-py Python包

请参阅单独的Python包的自述文件以获取详细信息。

生成文集网站

以下是生成ACL文集网站的基本说明,如https://aclantology.org网站/.

前提条件

要建立文集网站,您需要:

  • Python 3.8版或更高
  • 中列出的Python包bin/requirements.txt文件; 要安装,请运行pip-r bin/requirements.txt文件
  • 雨果0.58.3或更高(可以是直接从下载他们的回购; 这个扩展版本是必需的!)
  • 圣经用于创建非BibTeX引用格式(构建网站时没有严格要求,但如果没有它们,您需要按照详细自述文件)
  • 可选择的:如果安装libyaml-dev公司赛马拉松在运行之前制作第一次,将使用libyaml C库而不是python实施,加快构建。

使用GitHub构建和部署

有一个GitHub操作操作直接从GitHub执行部署。要使用此功能,您需要在存储库设置中定义此变量(web界面:设置->机密):

  • 出版物_SSH_密钥:用于身份验证的标准pem格式的密钥(无密码短语)

然后,只要主分支发生更改,GitHub就会自动构建和部署当前主分支。这是通过上传Makefile中的目标。

克隆

将Anthology repo克隆到本地计算机:

$git克隆https://github.com/acl-org/acl-anthology网站

生成

只要您正确安装了所有要求,就可以构建网站应该是简单的运行制作从目录中你克隆了回购协议。

完全生成的网站将位于建筑/选集之后。如果有任何错误在此步骤中,您可以参考详细的自述文件有关各个步骤的更多信息执行以构建站点。您可以通过启动来查看结果网站带有的本地web服务器发球,将在http://localhost:8000(本地主机:8000).

请注意,建立网站是一个资源密集型的过程;特别是最后一步,调用Hugo,使用大约18~GB的系统内存。在配备SSD的笔记本电脑上制作选集大约需要10分钟。

(注:这是真的意味着您需要在系统中使用此数量的RAM;在里面事实上,该网站可以很好地构建在一台具有8GB RAM的笔记本电脑上然而,由于交换,速度暂时减慢。大约18 GB的数字是运行时报告的最大RAM使用量雨果--缩小--步骤分析.)

可以通过运行以下命令在本地查看该选集hugo服务器在中雨果/目录。请注意,它重建了站点,因此需要大约一分钟后开始。

托管ACL选集的镜像

首先,创建镜像很慢,并且强调ACL选集因为在初始设置时,您必须下载每个来自官方网络服务器的选集的单个文件。这个可以无论速度有多快,都需要长达8个小时你的连接是。所以请不要只是为了好玩而玩这个。

如果要承载镜像,必须设置两个环境变量:

设置这些变量后,您可以运行制作创建页面和制作镜子将所有附加文件镜像到build/antology文件中目录。如果您之前已经创建了镜像,那么它只会下载丢失的文件。

如果要镜像文件而不是所有附件,可以运行制作镜像附件而不是。

然后将rsync构建/网站/目录到Web服务器,如果你在子目录中为镜子服务FOO公司,你的镜子构建/网站/FOO. The构建/选集目录需要同步到人类学档案Web服务器的目录。

由于您可能希望使镜像保持最新,因此可以修改shell脚本bin/acl-错误-cronjob.sh满足您的需求。

服务器上需要此软件

  • 远程同步
  • 吉特
  • 蟒蛇3
  • 雨果>0.58
  • 蟒蛇3-venv

如果希望构建过程更快,请安装赛马拉松3libyaml-dev公司(见上文)。

请注意,生成文集需要相当多的RAM,因此请确保您的机器上有。

贡献

如果您想参与ACL选集,请查看:

历史

该回购最初为wing-nus/acl,截至2017年6月5日已转让给acl-org。

许可证

构建ACL文集的代码分布在Apache许可证,2.0版.