acl anthology
1.0.0
Этот репозиторий содержит:
Официальный дом этого хранилища-https://github.com/acl-org/acl-anthology.
Пожалуйста, см. В отдельной Readme для пакета Python для подробной информации.
Это основные инструкции по созданию веб -сайта ACL Anthology, как видно на https://aclanthology.org/.
Чтобы создать веб -сайт антологии, вам понадобится:
bin/requirements.txt ; Чтобы установить, запустите pip -r bin/requirements.txtlibyaml-dev и Cython прежде чем запустить, make первый раз, библиотека Libyaml C будет использоваться вместо реализации Python, ускоряя сборку.Существует действие GitHub, выполняющее развертывание непосредственно от GitHub. Чтобы использовать это, вам необходимо определить эту переменную в настройках репозитория (веб -интерфейс: Настройки -> Секреты):
PUBLISH_SSH_KEY : секретный ключ в стандартном формате PEM для аутентификации (без пассийной фразы) Затем GitHub автоматически создаст и развертывает текущий мастер всякий раз, когда изменится главная ветвь. Это делается через цель upload в Makefile.
Клонировать антологию репо своей местной машине:
$ git clone https://github.com/acl-org/acl-anthology При условии, что вы правильно установили все требования, создание веб -сайта должно быть таким же простым работой make каталога, к которому вы клонировали репо.
Полностью сгенерированный веб -сайт будет впоследствии build/anthology . Если на этом этапе возникают какие -либо ошибки, вы можете проконсультироваться с подробным Readme для получения дополнительной информации о отдельных шагах, выполненных для создания сайта. Вы можете увидеть полученный веб -сайт, запустив локальный веб -сервер с make serve , который будет обслуживать его по адресу http: // localhost: 8000.
Обратите внимание, что создание веб-сайта является довольно ресурсным процессом; В частности, последний шаг, вызывая Хьюго, использует около 18 ~ ГБ системной памяти. Создание антологии занимает около 10 минут на ноутбуке с SSD.
( Примечание: это не означает, что вам нужно это количество оперативной памяти в вашей системе; фактически, веб -сайт хорошо строит на ноутбуке с 8 ГБ оперативной памяти. Система может временно замедляться из -за обмена, однако. Рисунок ок. 18 ГБ -это максимальное использование RAM, сообщаемое при запуске hugo --minify --stepAnalysis .)
Антологию можно просмотреть локально, запустив hugo server в каталоге hugo/ . Обратите внимание, что он восстанавливает сайт и, следовательно, заходит около минуты.
Во -первых, создание зеркала является медленным и подчеркивает инфраструктуру антологии ACL, потому что при первоначальной настройке вы должны загрузить каждый файл антологии из официального веб -сервера. Это может занять до 8 часов, независимо от того, насколько быстро ваше соединение. Так что, пожалуйста, не играйте с этим просто для развлечения.
Если вы хотите разместить зеркало, вам нужно установить две переменные среды:
ANTHOLOGY_PREFIX Префикс http Ваше зеркало будет доступно в соответствии с eg https://example.com/my-awesome-mirror или http://aclanthology.lst.uni-saarland.de (обратите внимание, что в конце нет черни!)ANTHOLOGYFILES Справочник, в котором документы, вложения и т. Д. будут находиться на вашем веб -сервере. Этот каталог должен быть читаемым вашим веб -сервером (очевидно), но не должен быть подкаталогом каталога зеркала антологии. С этими переменными, вы make чтобы создать страницы и make mirror для зеркала всех дополнительных файлов в каталоге Fult/Anthology Files. Если вы уже создали зеркало уже раньше, оно будет загружать только отсутствующие файлы.
Если вы хотите отразить бумаги, но не все вложения, вы можете вместо этого запустить make mirror-no-attachments .
Затем вы передаете build/website/ каталог в своем веб -сервере или, если вы обслуживаете зеркало в подкатальном FOO , вы отражаете build/website/FOO . Справочник build/anthology-files должен быть приведен в каталог ANTHOLOGYFILES вашего веб-сервера.
Поскольку вы, вероятно, хотите, чтобы зеркало было в курсе, вы можете изменить сценарий Shell bin/acl-mirror-cronjob.sh в соответствии с вашими потребностями.
Вам понадобится это программное обеспечение на сервере
Если вы хотите, чтобы процесс сборки был быстрым, установите cython3 и libyaml-dev (см. Выше).
Обратите внимание, что генерирование антологии занимает немало ОЗУ, поэтому убедитесь, что она доступна на вашей машине.
Если вы хотите внести свой вклад в антологию ACL, посмотрите на:
Этот репо был первоначально Wing-NUS/ACL и был переведен в ACL-ORG по состоянию на 5 июня 2017 года.
Код для построения антологии ACL распределен по лицензии Apache, v2.0.
