diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..de2d5e086e2655036e3565ded009a74dc7c65940 --- /dev/null +++ b/.gitignore @@ -0,0 +1,152 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/README.md b/README.md index d1e8338341ff456eb7a6a99f1c7231ddb05491e4..048821df8a27bba4bd7bd218ee5eb9aeb7e45bef 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ Exemple de projet reproductible -Dans cette version, on ajoute une gestion de l'aléatoire et du paramétrage et le workflow est formalisé de cette façon le futur expérimentateur est assuré de pouvoir reproduire avec + d'exactitude. \ No newline at end of file +Dans cette version, on ajoute une gestion de l'aléatoire et du paramétrage et le workflow est formalisé avec un gestion des tags. De cette façon l'expérimentateur peut plus facilement relancer avec les même paramètres et obtenir le même résultat \ No newline at end of file diff --git a/inputs/.gitkeep b/inputs/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/main.py b/main.py new file mode 100644 index 0000000000000000000000000000000000000000..25659dc2aacf798a384d0c23d8b6eb54565acb7d --- /dev/null +++ b/main.py @@ -0,0 +1,33 @@ +import numberGenerator +import outputModule +import yaml +from pathlib import Path + +def getParameters() -> dict: + with open("parameters.yaml") as f: + return yaml.safe_load(f) + +def saveInput(input): + with open("inputs/inputs.txt","w") as f: + for i in input: + f.write(str(i)+"\n") + +def saveOutput(output): + with open("outputs/outputs.txt","w") as f: + f.write(str(output)) + +if __name__ == '__main__': + print("Getting parameters from the 'parameters.yaml' file...") + params = getParameters() + min = params["min_value"] + max = params["max_value"] + numbers_to_generate = params["numbers_to_generate"] + + numberGenerator.setSeed(params["seed"]) + print(f"Generating {numbers_to_generate} random numbers between {min} and {max}...") + numbers = numberGenerator.generateNumbers(numbers_to_generate,min,max) + print("Generating output...") + output = outputModule.computeValues(numbers,min,max) + + saveInput(numbers) + saveOutput(output) \ No newline at end of file diff --git a/numberGenerator.py b/numberGenerator.py new file mode 100644 index 0000000000000000000000000000000000000000..1a7e474cf971099c2fd4b495435224798e068353 --- /dev/null +++ b/numberGenerator.py @@ -0,0 +1,10 @@ +import random + +def setSeed(seed) -> None: + random.seed(seed) + +def generateNumbers(tries,min=0,max=10) -> list[int]: + numbers = [] + for _ in range (tries) : + numbers.append(random.randint(min,max)) + return numbers \ No newline at end of file diff --git a/outputModule.py b/outputModule.py new file mode 100644 index 0000000000000000000000000000000000000000..bcb2b771d0fdbdab3ed481dc18d6dcfd9de4cc1a --- /dev/null +++ b/outputModule.py @@ -0,0 +1,9 @@ +import matplotlib.pyplot as plt +import numpy as np + +def computeValues(values,min=0,max=10) -> None: + plt.hist(values,range=(min,max),bins=max+1,color='blue',edgecolor='black') + print("figure saved in 'output/histogram.png'") + plt.savefig("outputs/histogram.png") + plt.show() + return float(np.average(values)) \ No newline at end of file diff --git a/outputs/.gitkeep b/outputs/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/parameters.yaml b/parameters.yaml new file mode 100644 index 0000000000000000000000000000000000000000..18b477c7ae29ddb0b5dba84db12b8a571797017f --- /dev/null +++ b/parameters.yaml @@ -0,0 +1,5 @@ +numbers_to_generate : 100 +#min and max values are included +seed : 128 +min_value : 0 +max_value : 10 \ No newline at end of file