Merge pull request #96 from mariuzka/mk/update_docs

Mk/update docs
mariuzka · Sep 24, 2024 · 14fb448 · 14fb448
2 parents e26a692 + 37e61fa
commit 14fb448
Show file tree

Hide file tree

Showing 11 changed files with 1,651 additions and 895 deletions.
diff --git a/docs/Introduction/introduction_basics.ipynb b/docs/Introduction/introduction_basics.ipynb
diff --git a/docs/Introduction/introduction_creator.ipynb b/docs/Introduction/introduction_creator.ipynb
diff --git a/docs/Introduction/introduction_inspector.ipynb b/docs/Introduction/introduction_inspector.ipynb
@@ -7,7 +7,7 @@
     "# Inspecting the network: The Inspector class\n",
     "\n",
     "When building network models, it is important to evaluate the created networks to ensure they are a valid representation of the target network.\n",
-    "For this purpose, pop2net provides a couple of tools."
+    "For this purpose, Pop2net provides a couple of tools."
    ]
   },
   {

diff --git a/docs/Introduction/introduction_simulations.ipynb b/docs/Introduction/introduction_simulations.ipynb
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -1,3 +1,15 @@
 .wy-nav-content {
     max-width: 900px !important;
 }
+
+/* margin after code cells */
+div.nbinput.nblast.docutils.container {
+    margin-bottom: 15px;
+    /* Adjust this value for more or less space after code cells */
+}
+
+/* margin after output cells */
+div.nboutput.nblast.docutils.container {
+    margin-bottom: 25px;
+    /* Adjust this value for more or less space after output cells */
+}
diff --git a/docs/api/creator.rst b/docs/api/creator.rst
@@ -1,6 +1,6 @@
 .. currentmodule:: pop2net.creator
 
-Population Maker
+Creator
 ================
 
 .. autoclass:: Creator

diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -10,6 +10,7 @@ API Reference
 
    agent
    location
+   magiclocation
    creator
    model
    utils
diff --git a/docs/api/magiclocation.rst b/docs/api/magiclocation.rst
@@ -0,0 +1,9 @@
+.. currentmodule:: pop2net
+
+MagicLocation
+========
+
+The MagicLocation class is an interface to design specific network structures using the Creator.
+
+.. autoclass:: MagicLocation
+    :members:
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,7 +40,7 @@ agentpy = "^0.1.5"
 tabulate = "^0.9.0"
 seaborn = "^0.12.1"
 faker = "^15.1.1"
-bokehgraph = "^0.6.0"
+bokehgraph = "^0.6.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.2.0"

diff --git a/src/pop2net/location.py b/src/pop2net/location.py
@@ -150,7 +150,7 @@ def __init__(self, model: _model.Model) -> None:
     def setup(self) -> None:
         """Use this method to set instance attributes, for instance.
 
-        This method is called automatically by the population maker after creating an instance.
+        This method is called automatically by the creator after creating an instance.
         """
 
     def filter(self, agent: _agent.Agent) -> bool:  # noqa: ARG002
@@ -177,8 +177,8 @@ def bridge(self, agent: _agent.Agent) -> float | str | list | None:  # noqa: ARG
             agent (_agent.Agent): The agent that is currently processed by the Creator.
 
         Returns:
-            float | str | list | None: The value which is used to assign agents
-                to location instances.
+            float | str | list | None:
+                The value which is used to assign agents to location instances.
         """
         return None
 
@@ -189,8 +189,8 @@ def split(self, agent: _agent.Agent) -> float | str | list | None:  # noqa: ARG0
             agent: The agent that is currently processed by the Creator.
 
         Returns:
-            float | str | list | None: The value(s) that determine(s) to which location instance
-                the agent is assigned.
+            float | str | list | None:
+                The value(s) that determine(s) to which location instance the agent is assigned.
         """
         return None
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ API Reference @@
        agent
        location
+       magiclocation
        creator
        model
        utils