= aligoNB for KAGRA =
<<TableOfContents(3)>>

  The original aligoNB is developed on [[https://git.ligo.org/NoiseBudget/aligoNB|https://git.ligo.org/NoiseBudget/aligoNB|LIGO Git]].
  Because this package depends on the LIGO's computer environment, some changes are required for using in KAGRA.
  So TY forked it on [[https://git.ligo.org/yamamoto/aligoNB/-/tree/kamioka?ref_type=heads]].
  Alteration for KAGRA is managed in {{{kamioka}}} branch.

-----

== Environment construction ==
  * On Kamioka/Mitaka workstations, environment is already constructed. So you can skip this section.
    * All packages are now available on {{{conda-forge}}}, though the {{{inspiral-range}}} package is installed via {{{pip}}} in the original installation manual.
    {{{
$ conda create -n aligoNB python=3.9
$ conda activate aligoNB
$ conda install -c conda-forge numpy scipy matplotlib nds2-client python-nds2-client gwinc gpstime astropy inspiral-range
    }}}
    * For accessing data easily, it's better to change some environmental variables automatically in the {{{aligoNB}}} environment.
    {{{
$ conda env config vars set NDSSERVER='k1nds2:8088'
    }}}

-----

== Installation of aligoNB ==
  * On the CDS workstation, aligoNB is already installed on {{{/users/Commissioning/aligoNB}}}.
  {{{
$ cd /path/to/somewhere
$ git clone https://git.ligo.org/yamamoto/aligoNB.git
$ git checkout -b kamioka origin/kamioka
  }}}
-----

== Quick start ==
  * It works only on CDS workstations in Kamioka and Mitaka.
  {{{
$ cd /users/Commissioning/aligoNB
$ conda activate aligoNB
$ python3 -m aligoNB K1
  }}}
-----

== Challenges ==
  * There is no way to share the measurement files between on-site and off-site.
  * There is no global NDS2 server.

=== How to share the measurement files? ===
  * On Git-LFS (same way as LIGO)
    * 50GB = $60/year?
    * For a long term usage, more large storage (= much money) is required.
  * On Git
    * We cannot do 'git clone' soon because of a too large repository.
  * On Local NFS disk
    * Only on-site (including Mitaka control room) people can contribute the noise budget activity.
  * On KAGRA Dropbox
    * The conflict problem must be fixed at first.
    * Dropbox must be installed as same path for sharing the noise budget code among collaborators.
      * {{{/kagra/Dropbox}}} on CDS workstations vs. {{{${HOME}/Dropbox}}} on the personal laptop for the most of people.