Skip to content

Commit

Permalink
Update get-started.rst
Browse files Browse the repository at this point in the history
Fix dead link and install instructions
  • Loading branch information
t-wolfeadam authored Mar 27, 2024
1 parent 2df7821 commit f9d60f1
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ Getting started

Installation
------------
Install this library by navigating to the ``dist`` directory in a terminal prompt and executing ``pip install anylogic-alpyne``/
To install this library from the source with minimum dependencies, execute ``pip install .``; from pypi, execute ``pip install anylogic-alpyne``.

To include the optional dependencies, for running the example scripts, use ``pip install .[examples]`` or ``pip install anylogic-alpyne[examples``.

Preparing an AnyLogic model
---------------------------
You can use *any* edition of AnyLogic (PLE, University, or Professional) with this library. However, be aware that limitations of the edition will still apply. For example, PLE users executing models which utilize industry-specific libraries have their runs limited to 1-hour simulation time.

You will need to setup your model with the following components. For more specifics on each entry, see the following section, `Components of an RL-ready model <intro_components.html>`_ and/or the official AnyLogic `RL Experiment Help Article <https://anylogic.help/anylogic/experiments/rl-experiment.html>`_.
You will need to setup your model with the following components. For more specifics on each entry, see the following section, `Components of an RL-ready model <components-rlready-model.html>`_ and/or the official AnyLogic `RL Experiment Help Article <https://anylogic.help/anylogic/experiments/rl-experiment.html>`_.

1. RL experiment, with the Configuration, Observation, Action, and stopping conditions filled out, as per your specifications
2. A call to the RL experiment's ``takeAction`` method, at the time you wish an action to be taken
Expand All @@ -27,4 +29,4 @@ In your Python code, you will create a single AnyLogicSim object which represent
In creating the AnyLogicSim, you pass a reference to where your exported model is located, in addition to options for log level, engine settings, and other behavioral options.
This object then gives you access to functions for interacting with the model run, including resetting it, querying its status, applying some action, and getting outputs.

You can learn more about the specifics from reviewing the other pages and the provided sample scripts.
You can learn more about the specifics from reviewing the other pages and the provided sample scripts.

0 comments on commit f9d60f1

Please sign in to comment.