| Authors: | Guillaume Oliviéro |
|---|---|
| Date: | 2023-01-26 |
| Contact: | oliviero@lp2ib.in2p3.fr |
Contents
Welcome on this repository centralizing a lot of information on different softwares or languages used in the world of academic research. My goal in my collaboration in particle physics was to give to new students a place to start to learn how to use our software stack. It can be relevant (or not) to you because I am working on a Particle Physics experiment so it can be too specific for you but you can adapt what you see here to your field or applications.
An useful way to get documemtation or help is through the Stackoverflow website. It is a question and answer website for programmers. It will become your best friend for each code or software related questions. People are smart and share a lots of their code on it.
Also, Github is also a good place to get software snippets you can copy and then adapt to your application.
Finally, ChatGPT can be also very useful. This artificial intelligence chatbot using supervised learning as well as reinforcement learning can help you on developping, debugging, understand a code or writing a documentation. You can ask him a lot of details on errors, code, documentation but also start to create some atomic program you'll use in your bigger applications. You can try to get more information from him giving him more context on who you are, for example a phd in particle physics or a software developper and he will go deeper in the explanations. Not 100% perfect so you must take care about the results but it can be helpful and worth mentioning it.
This repository is licenced under GNU General Public License v3.0.
Linux is supported.
For now, I have only tested the different tutorials on my personal machine which is:
Linux Mint Dell-Latitude-5420 5.15.0-60-generic #66-Ubuntu 22.04.2 LTS SMP x86_64 GNU/LinuxFor Mac user it should be close to Linux user and interface. Some things can change for paths or bash things. Please have a look online if you encounter specific issue related to mac-usage.
For Windows people, well... Good luck.
Please use the github issues system to open a discussion on a specific topic.
The main branch of this repo is protected and if you want to
contribute to it you must create a separate feature branch and open a
Pull Request.
Originally the idea of this repository was for our new students in the SuperNEMO collaboration to ahve a place to start learning software stuff. I made a list of recommandations for internship students, Summer students, PhD students, young researchers and more advanced people. Feel free to adapt to your needs of course but the list of software that are in the first section is, to me, the basics everyone must understand in research (especially in particle physics).
- Git tutorial
- Bash tutorial
- Documentation tutorial (rst, md, pandoc)
- Latex tutorial
- Cpp tutorial
- Doxygen tutorial
- Python tutorial
- Python matplotlib tutorial
- Python numpy tutorial
- ROOT tutorial
- Python pyroot and uproot
- Falaise tutorial (SuperNEMO people only)
- Supernemo shifter tutorial (SuperNEMO people only)
- All recommendations for Master or internship students
- Text editor tutorial (emacs or vim)
- Cmake tutorial
- Python pandas tutorial
- Python jupyter notebooks
- R tutorial (if you use it)
- All recommendations for PhD students
- Geant4 tutorial
- Boost library (short introduction)
- Bayeux tutorial
- Containers tutorial (Docker and Singularity)
Of course, if researchers, teachers or senior people want to do these tutorials as well, they are more than welcome ;).
- cmake: 100%
- pandoc: 100%
- git: 100%
- Latex: 100%
- Python_matplotlib: 100%
- reStructured Text: 50% (missing rst tutorial)
- Markdown: 50% (missing md tutorial)
- Bash: 75% (missing main tutorial / 1 use-case)
See General ressources file for a list of resources.