mirror of
https://gitlab.cern.ch/wotsubo/PSBoardDataBase.git
synced 2025-06-08 22:15:44 +09:00
50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
```@meta
|
|
CurrentModule = PSBoardDataBase
|
|
```
|
|
# このリポジトリのソフトウェアについての説明
|
|
|
|
このリポジトリにあるのは、JATHub masterのログファイル、及びGoogle SheetsからエクスポートしたCSVファイルからデータベースを作成するためのコードである。
|
|
メインの関数は[`create_database_from_exported_csvs`](@ref)である。
|
|
|
|
## 動かし方
|
|
[Julia](https://julialang.org)は[juliaup](https://github.com/JuliaLang/juliaup)でインストールする。
|
|
リポジトリのルート(`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]
|
|
|
|
[^1]: master log fileはgitには入れたくないので、このような形態をとっている。
|
|
|
|
# 新しいQAQCキャンペーン時に更新すべき内容
|
|
|
|
- [`PSBoardDataBase.insert_qaqc_campaign_id`](@ref): キャンペーンの日時
|
|
- [`PSBoardDataBase.get_campaign_id_from_run_id`](@ref): runidとの関係
|
|
|
|
# API
|
|
|
|
```@index
|
|
```
|
|
|
|
```@autodocs
|
|
Modules = [PSBoardDataBase]
|
|
```
|
|
|
|
## `QaqcMasterLog`
|
|
|
|
```@autodocs
|
|
Modules = [QaqcMasterLog]
|
|
```
|