diff --git a/README.md b/README.md index 6f23aece4c401595a474a271e7b82114b7565700..8bee83808a9362fe784e1e573242fcf0410e10f6 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,37 @@ # Circuit RC +par Marty Hugo, Malezieux Julien, Rouiller Cyril et Wenger Tom +## Fil conducteur +Votre seriez bien inspirés de suivre les points suivants. +1. Dessinez un circuit RC (pensez à bien le décrire). -## Getting started +2. A l’aide de l’équation de la conservation de l’énergie (Vin(t)+VR(t)+VC(t)=0), dérivez une équation itérative pour l’évolution de la tension dans le condensateur. Indication: n’oubliez pas que I(t)=ΔQ/Δt=(Q(t+δt)−Q(t))/δt et que Q(t)=C⋅VC(t). -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +3. Maintenant que vous avez obtenu une équation de la forme VC(t+δt)=VC(t)+Δt⋅... vous pouvez enfin implémenter votre simulateur en C (oui c’est obligatoire). Celui-ci doit pouvoir fonctionner avec une source de tension dépendante du temps. N’oubliez pas qu’en plus d’avoir cette équation itérative, vous devez imposer une source de tension et une condition initiale. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +4. Une fois votre simulateur écrit, vous devez le valider. Trouvez un moyen de valider votre simulateur sur deux cas simples. *Indication: une validation visuelle, bien que pas très formelle est une première étape utile. Vous pouvez utiliser une librairie graphique telle que plplot par exemple, ou alors écrire les fichiers dans un fichier et les faire visualiser à l’aide d’autres outils, matplotlib par exemple. Une fois validée visuellement essayez de quantifier l’erreur que vous commettez en simulant le monde.* -## Add your files +5. Normalement votre simulateur dépend de valeur de δt, R et de C. Fixez des valeurs de R, C, et jouez avec une grande gamme de δt sur les cas de validation et regardez l’effet. Que voyez vous? -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +6. A l’aide de votre simulateur, modélisez un filtre passe-bas (ou un intégrateur). Pour ce faire, il faut générer un signal haute fréquence (ici Vin(t) est le signal) et essayez de le filtrer (VC(t) est le signal filtré). Il faut donc bien comprendre ce qu’est un filtre passe bas, et quels sont les paramètres de votre simulateurs qui permettent de filtrer un signal. -``` -cd existing_repo -git remote add origin https://gitedu.hesge.ch/hugo.marty/circuit-rc.git -git branch -M main -git push -uf origin main -``` +7. Pour un bonus: Faites de même pour un filtre passe-haut (ou un dérivateur). Pour ce faire, il faut bien comprendre ce qu’est un filtre passe-haut, et quels sont les paramètres de votre simulateurs qui permettent de filtrer un signal. -## Integrate with your tools +## La présentation -- [ ] [Set up project integrations](https://gitedu.hesge.ch/hugo.marty/circuit-rc/-/settings/integrations) +Votre présentation doit contenir les éléments suivants. -## Collaborate with your team +1. Une introduction présentant le cadre général du travail (pas “le professeur nous a demandé”, mais plutôt ce que vous essayez de faire). -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +2. Une présentation de la théorie (la dérivation des équations à résoudre, la condition initiale). -## Test and Deploy +3. Une présentation de votre simulateur et sa validation. -Use the built-in continuous integration in GitLab. +4. Une présentation des résultats concernant les filtres et comment utiliser votre simulateur pour les modéliser. -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +5. Une conclusion qui rappelle ce que vous avez réalisé et les résultats obtenus. -*** +6. Une petite démonstration de l’exécution de votre code. -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Avoir des slides pour soutenir votre propos et présenter des graphiques serait une bonne idée. \ No newline at end of file