diff --git a/README.md b/README.md index 0ef18163be3fa9dd0edff66bdec1ab02c86122a9..e43d06f14c3fa5f3dbbdb5787fe79ea8a01003a5 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,36 @@ Furthermore, we refer to following sources: ## Using this repo (development only) +**Configuration** +#### Requirements +__Download in this order__: +- [Notepad++](https://notepad-plus-plus.org/downloads/v8.4.1/) +- [Putty/PuttyGen](https://www.puttygen.com/download-putty) +- [Git for windows] (https://gitforwindows.org/) + +#### Configuration + +1) Create GitLab account on [wur gitlab](https://git.wur.nl/) +2) Open PuttyGen and generate a public-private key pair, for example a ssh-ed25519. + - save both in a folder on your computer, e.g. in "C:/users/user_name/.ssh/" + - copy the public key to your GitLab profile in Preferences > SSH Keys > Add an SSH key + - the format is as follows: "ssh-ed25519 AAAAC3NzaC1lZDI1NTExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + - or "ssh-rsa AAAAAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +3) go to Access Tokens > Add a personal access token > select all options > create. Save your token in a password manager and keep it close +4) For enabling two-factor authentication, scan the code with your authenticator app (plus in right upper corner > other) + - save the recovery codes in a safe place or passwork manager + + +#### Connect + +1) create group on gitlab for your project +2) create a repository (= project) on GitLab +3) click "clone" + copy link to clone with https +3) open git bash in your local folder where you want to put the repository (right mouse click > Git Bash Here) +4) type "git clone _copied_link_to_repo_ " +5) enter your wur mailadress and NOT the password, but the TOKEN you copied in the previous part step 3. + + **Initialisation** - on your local computer: go to project folder (in my case: C:\Users\adria036\OneDrive - Wageningen University & Research\iAdriaens_doc\Projects\iAdriaens\bait\code\) - open git Bash (*Git Bash Here*) @@ -57,6 +87,7 @@ git clone https://git.wur.nl/iadriaens/bait.git cd bait ``` +**Working with git (if alone)** - make changes locally and commit them - this will only keep track of your changes locally (on your own pc) - git status = which changes have or have not been committed @@ -74,16 +105,29 @@ git commit -m "meaningful_message" - the changes in your local branch need to be merged into main in the remote - push local branch and ask for merge (or merge yourself) +**Working with git (if others work with you)** + ``` git pull git checkout -b new_branch_name ``` +commit changes: +``` +git status +git add . +git commit -m "meaningful_message" +``` + + - to push your local changes to the remote, depending whether you worked in 'main' branch or a local branch ``` git push origin new_branch_name (or main) ``` +In the remote, you can now create a merge request to add your changes to the main. + + ## Contributing Once the tool is developed, we will be open for collaborations: diff --git a/documentation/20220510_datasets_BIAT.md b/documentation/20220510_datasets_BIAT.md new file mode 100644 index 0000000000000000000000000000000000000000..85b9721c1f09adcc061eeaa5fc2d1b9ad6be23af --- /dev/null +++ b/documentation/20220510_datasets_BIAT.md @@ -0,0 +1,47 @@ +## BAIT - dataset options + +### NLAS + +- Data NLAS - DC: + - NEDAP: herkauwen, vreten, rusten (Accelerometers & positie) + - UWB / acceleration + +### WBVR +- dierverzorgers +- wanneer terug normaal +- Vogelgriep eenden: goed- niet goed- + - camera beelden van de zijkant (symptomen) + - Detectie van abnormale bewegingen + - voor en na infectie -- ziekte wanneer afwijkend + +- Schapen: + - UWB + - voor en na infectie virus + +### Data Malou +- Kippen: + - individuele locaties + - video data met tracks - aantal dieren die aan het lopen zijn + - tracking ++ + +### Data Ines +Koeien: + - UWB + - Drinkgedrag + + +### Andere opties +Synthetische data gebruiken? + + +------------ + +## Administration - notes +- icologic voor offertes +- CRM ingeven nieuwe projecten/acquisitie (customer relation management) +- Myprojects voor projectbeheer +- WBI voor overzichten uren + +- data storage finder + + diff --git a/documentation/logo copy.pdf b/documentation/bin/logo copy.pdf similarity index 100% rename from documentation/logo copy.pdf rename to documentation/bin/logo copy.pdf