doc update (switching to readthedocs.io)

yasserfarouk · Nov 27, 2023 · e1a2462 · e1a2462
1 parent cc66158
commit e1a2462
Show file tree

Hide file tree

Showing 10 changed files with 10,492 additions and 10,495 deletions.
diff --git a/README.rst b/README.rst
@@ -16,7 +16,7 @@ Overview
     * - Gitter
       - | General |gitter| Standard |std| Collusion |collusion| OneShot |oneshot|
 .. |docs| image:: https://readthedocs.org/projects/scml/badge/?style=flat
-    :target: http://www.yasserm.com/scml/scml2020docs
+    :target: https://scml.readthedocs.io/en/latest
     :alt: Documentation Status
 
 .. |codecov| image:: https://codecov.io/gh/yasserfarouk/scml/branch/master/graph/badge.svg

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -11,6 +11,3 @@ applicability to a variety of problems.
     tutorials/01.run_scml2020
     tutorials/02.develop_agent_scml2020_oneshot
     tutorials/03.develop_agent_scml2020
-    tutorials/04.experiments
-    tutorials/05.logs_and_stats
-    tutorials/06.ideas
diff --git a/docs/tutorials/notebooks/01.run_scml2020.ipynb b/docs/tutorials/notebooks/01.run_scml2020.ipynb
diff --git a/docs/tutorials/notebooks/04.experiments.ipynb b/docs/tutorials/notebooks/04.experiments.ipynb
@@ -880,7 +880,7 @@
             "source": [
                 "### Controlling other aspects of the simulation\n",
                 "\n",
-                "You can control other aspects of the simulation by passing specific paramters to the [generate()](http://www.yasserm.com/scml/scml2020docs/api/scml.oneshot.SCML2020OneShotWorld.html?scml.oneshot.SCML2020OneShotWorld.generate#scml.oneshot.SCML2020OneShotWorld.generate) method or the [World constructor](http://www.yasserm.com/scml/scml2020docs/api/scml.oneshot.SCML2020OneShotWorld.html?) directly. \n",
+                "You can control other aspects of the simulation by passing specific paramters to the [generate()](https://scml.readthedocs.io/en/latest/api/scml.oneshot.SCML2020OneShotWorld.html?scml.oneshot.SCML2020OneShotWorld.generate#scml.oneshot.SCML2020OneShotWorld.generate) method or the [World constructor](https://scml.readthedocs.io/en/latest/api/scml.oneshot.SCML2020OneShotWorld.html?) directly. \n",
                 "\n",
                 "Here is an example in which we use `generate()` and fix the inital balance of all agents to $1000$ while fixing the production cost of everyone to $20$, increasing the number of production lines to $20$, and setting the number of simulation steps (days) to $40$ while making all negotiations go for $100$ steps instead of $20$ keeping the number of negotiation steps per day at $101$ which means that negotiations are still guaranteed to finish within the same day in which they are started. This configuration is very different than the one used by default in the official competition but you can decide to test it:"
             ]
@@ -1199,7 +1199,7 @@
             "source": [
                 "### Controlling Profiles\n",
                 "\n",
-                "In the previous example, we used `generae()` to do our bidding instead of directly calling the world constructore. Why? The main reason is that `generate()` creates profiles and exogenous contracts compatible with our settings so that it is possible --- in principly --- to make money in the generated world. Moreover, this is controllable by its parameters (see `profit_*` parameters [here](http://www.yasserm.com/scml/scml2020docs/api/scml.oneshot.SCML2020OneShotWorld.html?scml.oneshot.SCML2020OneShotWorld.generate#scml.oneshot.SCML2020OneShotWorld.generate)). We can push things a little further by controlling the profile of each agent independently (which in this case is just its production cost). We will generate a world in which agents have costs from $1$ to $7$.\n"
+                "In the previous example, we used `generae()` to do our bidding instead of directly calling the world constructore. Why? The main reason is that `generate()` creates profiles and exogenous contracts compatible with our settings so that it is possible --- in principly --- to make money in the generated world. Moreover, this is controllable by its parameters (see `profit_*` parameters [here](https://scml.readthedocs.io/en/latest/api/scml.oneshot.SCML2020OneShotWorld.html?scml.oneshot.SCML2020OneShotWorld.generate#scml.oneshot.SCML2020OneShotWorld.generate)). We can push things a little further by controlling the profile of each agent independently (which in this case is just its production cost). We will generate a world in which agents have costs from $1$ to $7$.\n"
             ]
         },
         {
@@ -1547,7 +1547,7 @@
             "source": [
                 "You can confirm for yourself that this is exactly what we expected.\n",
                 "\n",
-                "Let's first discuss the profile. In `SCML2021World`, an agent's profile consists of the production cost **per line per product**. You can see the full definition [here](http://www.yasserm.com/scml/scml2020docs/api/scml.scml2020.FactoryProfile.html). That is why we needed to create a 2D array of costs.\n",
+                "Let's first discuss the profile. In `SCML2021World`, an agent's profile consists of the production cost **per line per product**. You can see the full definition [here](https://scml.readthedocs.io/en/latest/api/scml.scml2020.FactoryProfile.html). That is why we needed to create a 2D array of costs.\n",
                 "\n",
                 "Exogenous contract structure is self explanatory. You have to specify the product, delivery time, quantity, and unit price. Moreover, you have to specify the time at which this contract is revealed to its agent (which must be before or at the delivery time step). The one thing you should be careful about is setting the *buyer* to $-1$ for exogenous sales and the *seller* to $-1$ for exogenous supplies. You can in principle have exogenous contracts in the middle of the chain but we do not do that usually.\n",
                 "\n",