Inorganic Chemistry Knowledge Base

База знаний проекта по химии "0-zone"

Содержание

1. Инструкция по созданию своей копии базы
2. Установка системы
3. Запуск системы
4. Клонирование базы (ТОЛЬКО НА ПУСТОЙ OSTIS)
5. Отправка изменений (с ветки master)
6. Получение изменений
7. Основные ссылки
8. TODO файл
9. Краткая информация о содержимом

Инструкция по созданию своей копии базы

• Форкнуть себе репозиторий (вверху есть кнопка Fork)

Установка системы

Установка осуществляется с системы ubuntu через терминал

$ git clone https://github.com/ShunkevichDV/ostis здесьМожноВвестиСвоеНазваниеДляПапкиСистемы

Если не ввести название папки, то она будет называться ostis

$ cd ostis/scripts
$ ./prepare.sh

Если что-то спросит, то соглашаемся, вводим пароль, когда запросит и т.д.

Запуск системы

Открываем терминал

$ cd ostis/scripts
$ ./restart_sctp.sh

Открываем новую вкладку (CTRL + SHIFT + T)

$ ./run_scweb.sh

Открываем браузер и вводим адрес

localhost:8000

Клонирование базы (ТОЛЬКО НА ПУСТОЙ OSTIS)

Открываем терминал

$ cd ostis

ВНИМАНИЕ!!! Следующая команда удалит папку kb (совсем, полностью, без возможности восстановления, но вы и так должны это знать)

$ rm -f -R  kb
$ git clone ссылкаНаВашуКопиюРепозитория kb
$ cd kb
$ git remote add mainRepository https://github.com/Maribo27/chemistry_kb
$ git fetch mainRepository
$ git checkout -b main mainRepository/master
$ git checkout master

Отправка изменений (с ветки master)

• Закоммитить и залить на свой репозиторий локальные изменения

$ git add --all
$ git commit -m "commit description"
$ git push

• Настоятельно рекомендую ознакомиться с данной статьёй: много маленьких коммитов это, конечно, хорошо, но склеивайте хотя бы такие коммиты, как:

Merge pull request Merge remote-tracking branch 'upstream/master'

• Создать пуллреквест c комментарием в формате:

[Имя Фамилия] Комментарий.

• Отметить в Trello

Получение изменений

• Изменения на ветке master должны быть закомичены и, желательно, приняты мной

$ git checkout main
$ git pull
$ git checkout master
$ git merge main

Основные ссылки

• Google Doc - у каждого курса свой лист
• Trello

TODO файл

Если берете файлы на формализацию, из этого списка, то помечаете это в гугл доке и на трелло и отписываете мне

Краткая информация о содержимом

• Agents - папка с агентами
• Concepts - папка с понятиями (все понятия нужно переместить в разделы и удалить)
• Elements - папка с химическими элементами
• Sections - декомпозиция базы
• Additional - папка с понятиями, которые не относятся к основным разделам
  • Agents - файлы, необходимые для агентов, но неотносящиеся к системе
  • Parameters - параметры (степени окисления, группы, периоды, числа)
• menu - элементы меню (вопросы, агенты)
• Substances - папка с химическими веществами
• README.md - read me файл
• TODO - понятия, которых нет в базе, но на них есть ссылки
• concepts.scs - абсолютные понятия и идентификаторы, которых нет в базе, но на них есть ссылки (если берете их на формализацию, то помечаете это в гугл доке и на трелло)
• nrels.scs - относительные понятия и идентификаторы, которых нет в базе, но на них есть ссылки (если берете их на формализацию, то помечаете это в гугл доке и на трелло)
• rrels.scs - ролевые понятия и идентификаторы, которых нет в базе, но на них есть ссылки (если берете их на формализацию, то помечаете это в гугл доке и на трелло)