vlcSim 0.3.0__tar.gz → 0.3.1__tar.gz

{vlcSim-0.3.0 → vlcSim-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcSim
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python Package of Event-Oriented Simulation for visible light communication
 Home-page: https://gitlab.com/DaniloBorquez/simvlc/
 Author: Danilo Bórquez-Paredes

{vlcSim-0.3.0 → vlcSim-0.3.1}/setup.py

@@ -10,7 +10,7 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="vlcSim",
-    version="0.3.0",
+    version="0.3.1",
     license="MIT",
     description="Python Package of Event-Oriented Simulation for visible light communication",
     author="Danilo Bórquez-Paredes",

{vlcSim-0.3.0 → vlcSim-0.3.1}/vlcSim.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcSim
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python Package of Event-Oriented Simulation for visible light communication
 Home-page: https://gitlab.com/DaniloBorquez/simvlc/
 Author: Danilo Bórquez-Paredes

{vlcSim-0.3.0 → vlcSim-0.3.1}/vlcsim/scene.py

@@ -1,5 +1,5 @@
 """
-This module work with the classes belonging to the Scene. It manages the physical sustrate.
+It manages the physical sustrate. 
 """
 
 import numpy as np
@@ -10,7 +10,13 @@ import warnings
 
 class AccessPoint:
     """
-    Class representing a generic access point
+    Class representing a generic access point. The :class:`vlcsim.scene.AccessPoint` class is in charge of managing the physical sustrate. It has the following attributes:
+
+    - **x**: **x** coordinate of the position of this VLed.
+    - **y**: **y** coordinate of the position of this VLed.
+    - **z**: **z** coordinate of the position of this VLed.
+    - **state**: Current state of the access point. Could be IDLE or BUSY.
+    - **sliceTime**: Time of the slice in [s]
     """
 
     stateap = Enum("state", "IDLE BUSY")
@@ -532,21 +538,21 @@ class Receiver:
         :param z: z coordinate of the object's coordinate.
         :param aDet: aDet value of the object's coordinate.
         :param ts: time of the object's coordinate. Default is 10 seconds.
-        :param index
+        :param index:
         :param fov: q of the object. Default is 1. 6e - 19.
-        :param q
+        :param q:
         :param s: ibg b - parameter of the Ib - Galactic model. Default i 5 seconds.
         :param b: c b - parameter of the Ib - Galactic model. Default is 5 seconds.
-        :param ibg
-        :param cb
-        :param tk
+        :param ibg:
+        :param cb:
+        :param tk:
         :param a: n n - prameter of the B - parameter. Default is 10 seconds.
-        :param gv
-        :param n
-        :param fr
-        :param gm
-        :param i1
-        :param i2
+        :param gv:
+        :param n:
+        :param fr:
+        :param gm:
+        :param i1:
+        :param i2:
         """
         self.__x = x
         self.__y = y