Merge branch 'JulienPeloton/solution-tp3' into 'master'

Julien peloton/solution tp3

See merge request !31

TP3/CONTRIBUTING.md

+To start, it helps to announce what you are working on ahead of time to
+confirm that it is an acceptable contribution. To do this open an issue/PR or send
+an email to [email].
+
+## Issues
+
+Feel free to submit issues and enhancement requests.
+
+## Contributing
+
+In general, we appreciate the "fork-and-pull" Git workflow.
+
+* Fork the repo on GitHub
+* Clone the project to your own machine and set up a new branch
+* Commit changes to your branch
+* Push your work back up to your fork
+* Submit a Pull request so that we can review your changes
+* Label your PR to help the tracking and prioritisation of your contribution.
+
+NOTE: Be sure to merge the latest from "upstream" before making a pull request!
+
+## Branch naming
+
+Using some form of convention to define the name of a branch for your PR is always a good idea. We do not have strong preference. For reference, here are some conventions:
+
+- Relating to a particular issue: `issue/issue-number/few-word-description`
+- Relating to a particular user: `u/your-username/few-word-description`
+
+Feel free to pick up one or another!
+
+## Code style
+
+Make sure the new code to be introduced is documented and has been tested.
+Please include the corresponding unit test with your code, and do not hesitate
+to have a high verbosity in your comments ;-)
+We tend to reject large contributions without any comments or tests.
+Also make sure your new contribution does not break the current test suite
+(or explain why we did a mistake!).

TP3/LICENSE

+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

TP3/ReadMe.md

 ## TP3 - Gestion de la documentation
 
-**Challenge:** Le post-doc génial du groupe est parti. Il travaillait sur un code super classe pour estimer les paramètres d'un modèle à partir de données d'une expérience de macro-biologie quantique en milieu relativistique.  
+**Challenge:** Le post-doc génial du groupe est parti. Il travaillait sur un code super classe pour estimer les paramètres d'un modèle à partir de données d'une expérience de macro-biologie quantique en milieu relativiste.  
 Il a laissé son code dans /TP3, mais il n'a écrit aucune documentation ! A vous de jouer pour le documenter avant la release de la fin de semaine.
 
 ----
@@ -112,4 +112,4 @@ Le maintien de la documentation est plus efficace si la chaîne d'exécution est
          - public
       only:
       - master
----
\ No newline at end of file
+---

TP3/docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

TP3/docs/_build/html/.buildinfo

+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 271e55edfb257002d08968cd41156e84
+tags: 645f666f9bcd5a90fca523b33c5a78b7

TP3/docs/_build/html/_sources/index.rst.txt

+.. Fitter documentation master file, created by
+   sphinx-quickstart on Tue Oct 12 20:54:40 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Fitter's documentation!
+==================================
+
+.. image:: _static/example.png
+  :align: center
+  :alt: Alternative text
+
+
+Rationale
+------------
+
+La porte refusa de s'ouvrir et déclara:
+- Cinq cents, s'il vous plaît.
+A nouveau, il chercha dans ses poches. Plus de pièces; plus rien.
+- Je vous paierai demain, dit-il à la porte. (Il essaya une fois de plus d'actionner le verrou, mais celui-ci demeura fermé.). Les pièces que je vous donne constitue un pourboire, je ne suis pas obligé de vous payer.
+- Je ne suis pas de cet avis, dit la porte. Regardez dans le contrat que vous avez signé en emménageant dans ce conapt.
+Il trouva le contrat dans le tiroir de son bureau: depuis que le document avait été établi, il avait eu besoin maintes et maintes fois de s'y référer. La porte avait raison; le paiement pour son ouverture et sa fermeture faisait partie des charges et n'avait rien de facultatif.
+- Vous avez pu voir que je ne me trompais pas, dit la porte avec une certaine suffisance.
+Joe Chip sortir un couteau en acier inoxydable du tiroir à côté de l'évier; il s'en munit et entreprit systématiquement de démonter le verrou de sa porte insatiable.
+- Je vous poursuivrai en justice, dit la porte tandis que tombait la première vis.
+- Je n'ai jamais été poursuivi en justice par une porte. Mais je ne pense pas que j'en mourrai. *PKD*
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: General
+   :hidden:
+
+   source/usermanual/installation
+   source/usermanual/quickstart
+   source/usermanual/contribute
+
+.. toctree::
+  :hidden:
+  :maxdepth: 1
+  :caption: API Reference
+
+  source/api/tp3.rst
+  source/api/tp3_documented.rst

TP3/docs/_build/html/_sources/source/api/modules.rst.txt

+TP3
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   tp3

TP3/docs/_build/html/_sources/source/api/tp3.rst.txt

+tp3 module
+==========
+
+.. automodule:: tp3
+   :members:
+   :undoc-members:
+   :show-inheritance:

TP3/docs/_build/html/_sources/source/api/tp3_documented.rst.txt

+tp3\_documented module
+======================
+
+.. automodule:: tp3_documented
+   :members:
+   :undoc-members:
+   :show-inheritance:

TP3/docs/_build/html/_sources/source/usermanual/contribute.rst.txt

+How to contribute
+==================
+
+.. include::  ../../../CONTRIBUTING.md
+   :parser: myst_parser.sphinx_