Merge pull request #20 from jgrguric96/documentation/DocStrings

Improve source code by adding docstrings to code base.

.gitignore

@@ -1,5 +1,172 @@
-__pycache__/
+# Additional
 .DS_Store
+.vscode
+
+Result/ 
+environment_alex.yaml
+#############################
+#### .gitignore template ####
+#############################
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
 
-_build/
+# 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/

Agents/prosumer_S_model.py

@@ -1,8 +1,36 @@
 from Agents.prosumer_model import prosumer_python
-
+import pandas as pd
 
 class prosumer_S1(prosumer_python):
-    def prosumer(self, start, time, generators, demands, storages, em_accepted_bids, ft_transactions):
+    def prosumer(self, start:pd.Timestamp, time:pd.Timestamp, generators:pd.DataFrame, demands:pd.DataFrame, storages:pd.DataFrame, em_accepted_bids:list, ft_transactions:list) -> dict:
+        """
+        Initializes all given parameters and returns 
+
+        ...
+
+        Parameters
+        ----------
+        start : pandas.Timestamp
+            The starting point in time.
+        time : pandas.Timestamp
+            A representation of the current point in time.
+        generators : pandas.DataFrame
+            Generated values used for populating the self.generator variable with forecasted data
+        demands : pandas.DataFrame
+            Demand values used for populating the self.demands variable with forecasted data
+        storages : pandas.DataFrame
+            Storage values used for populating the self.storages variable with forecasted data
+        em_accepted_bids : list
+            ???
+        ft_transactions : list
+            ???
+
+        Returns
+        -------
+        self.re_params : dict
+            Returns a dictionary used in steps (???)
+            
+        """
         self.initialize(start, time, generators, demands, storages, em_accepted_bids, ft_transactions)
 
         self.re_params = {}
@@ -27,6 +55,35 @@ def prosumer(self, start, time, generators, demands, storages, em_accepted_bids,
 
 class prosumer_S2(prosumer_python):
     def prosumer(self, start, time, generators, demands, storages, em_accepted_bids, ft_transactions):
+        """
+        Initializes all given parameters and returns 
+
+        ...
+
+        Parameters
+        ----------
+        start : pandas.Timestamp
+            The starting point in time.
+        time : pandas.Timestamp
+            A representation of the current point in time.
+        generators : pandas.DataFrame
+            Generated values used for populating the self.generator variable with forecasted data
+        demands : pandas.DataFrame
+            Demand values used for populating the self.demands variable with forecasted data
+        storages : pandas.DataFrame
+            Storage values used for populating the self.storages variable with forecasted data
+        em_accepted_bids : list
+            ???
+        ft_transactions : list
+            ???
+
+        Returns
+        -------
+        self.re_params : dict
+            Returns a dictionary used in steps
+            
+            
+        """
         self.initialize(start, time, generators, demands, storages, em_accepted_bids, ft_transactions)
 
         self.re_params = {}
@@ -50,4 +107,7 @@ def prosumer(self, start, time, generators, demands, storages, em_accepted_bids,
 
 
 class prosumer_S3(prosumer_python):
+    """
+    Inherits Prosumer_python, does nothing else different
+    """
     pass