====== NervProj Framework ======

====== Task list and TODOs ======

  * [[nervproj_task_list|Tasks list & TODOs]]

===== Usage notes =====

==== Initial framework setup ====

To setup the NervProj management system, the following steps are required:

  - Clone the git repository:
    * For project members: <sxh bash; highlight: []>git clone git@github.com:roche-emmanuel/nervproj.git NervProj</sxh>
    * For non-project members: <sxh bash; highlight: []>git clone https://github.com/roche-emmanuel/nervproj.git NervProj</sxh>
  - Init the nvp command support by installing the cli: <sxh bash; highlight: []>cd NervProj
./cli.sh admin install cli</sxh>
    * Adding the cli should end with output lines similar to: <sxh bash; highlight: []>2022/07/18 09:06:45 [nvp.core.admin] INFO: Home folder is: /home/kenshin
2022/07/18 09:06:45 [nvp.core.admin] INFO: Adding source file in .bashrc for NervProj</sxh>
  - Restart your terminal to load the cli script
  - The nvp command should then be available: <sxh bash; highlight: []>kenshin@rog:~$ nvp home
kenshin@rog:~/projects/NervProj$ nvp git pullall
2022/07/18 09:09:21 [nvp.core.git_manager] INFO: Pulling NVP framework...
Already up to date.</sxh>


<note>Installing the "cli" will first install the default python environment and tools which may take some time.</note>

  * Next we need to setup the ssh keys/config and configure git to handle the NVP managed projects easily: <sxh bash; highlight: []>kenshin@rog:~$ nvp git setup
2022/07/18 09:30:00 [nvp.core.git_manager] INFO: Validating git setup in home dir '/home/kenshin'
2022/07/18 09:30:00 [nvp.core.git_manager] INFO: Installing ssh private key /home/kenshin/.ssh/id_rsa_gitlab.eumetsat.int_git
2022/07/18 09:30:00 [nvp.core.git_manager] INFO: Adding gitlab.eumetsat.int to known_hosts...
Welcome to GitLab, @eroche!
2022/07/18 09:30:01 [nvp.core.git_manager] INFO: Installing ssh private key /home/kenshin/.ssh/id_rsa_gitlab.gmv-insyen.com_git
2022/07/18 09:30:01 [nvp.core.git_manager] INFO: Adding gitlab.gmv-insyen.com to known_hosts...
Welcome to GitLab, @manu!
2022/07/18 09:30:05 [nvp.core.git_manager] INFO: Installing ssh private key /home/kenshin/.ssh/id_rsa_gitlab.insyen.com_git
2022/07/18 09:30:05 [nvp.core.git_manager] INFO: Adding gitlab.insyen.com to known_hosts...
Welcome to GitLab, @manu!</sxh>


==== Cloning an NVP project ====

  * To clone an NVP project we can use for instance (in the correct parent folder): <sxh bash; highlight: []>$ nvp git clone -p t7 eum_resp_t7</sxh>

==== Noticeable sub-projects and tools ====

  * [[0001_whisper_gen|OpenAI Whisper command-line tool]]