PSBoardDataBase/docs/src/about_software.md

1.9 KiB

CurrentModule = PSBoardDataBase

このリポジトリのソフトウェアについての説明

このリポジトリにあるのは、JATHub masterのログファイル、及びGoogle SheetsからエクスポートしたCSVファイルからデータベースを作成するためのコードである。 メインの関数はcreate_database_from_exported_csvsである。

動かし方

Juliajuliaupでインストールする。 リポジトリのルート(Project.tomlがある)で

$ julia --project

をするとJuliaのREPLが立ち上がる。

]をおしてPkgモードに入り、instantiateを実行すると、必要なパッケージを自動でインストールする。

backspaceでjulianモードに戻り(左側がjulia>になってる)、using PSBoardDataBaseをすると使えるようになる。

?を押すとhelpモードに入り、関数名などをいれるとそのドキュメント(下にあるものと同じ)が閲覧できる。

PSBoardDataBase.create_database_from_exported_csvsを検索すると使い方がわかる。

テストについて

テストでは実際にデータベースを作成している。 デフォルトでは全部は実行しないが、master log fileをおき、かつ環境変数LOCAL_TESTを設定することで、master log fileが必要な工程まで含めて実行できる。1

新しいQAQCキャンペーン時に更新すべき内容

API

Modules = [PSBoardDataBase]

QaqcMasterLog

Modules = [QaqcMasterLog]

  1. master log fileはgitには入れたくないので、このような形態をとっている。 ↩︎