Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
t-wolfeadam authored Mar 15, 2024
1 parent e2332da commit 05fff14
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ This is a Python library for interactively running models exported from the RL e

Currently, this library released as a **public beta** (so please excuse any rough edges). If you have problems or bugs, please file them in the `Issues` tab. For general talk or questions, there's the `Discussions` tab.

**UPDATE (Oct 2023):** An overhaul to the backend is currently an active WIP. Estimated release is EOY (likely sooner though).

Full documentation (with background information, getting started guide, and class docs) can be found @ https://t-wolfeadam.github.io/Alpyne

All contributions, including new or improved example models and training scripts, are thoroughly welcomed!

Installation
------------
Alpyne supports Python 3.10+ and requirements the latest version of AnyLogic.
Alpyne supports Python 3.10+ and requirements the latest version of AnyLogic (as of Mar 2024: v8.8.6).

To install this library with its base minimum components, use ``pip install anylogic-alpyne``

Expand Down Expand Up @@ -47,4 +45,4 @@ Before running the example scripts, you'll need to first export them from AnyLog
1. Open the given model in AnyLogic (e.g., `examples/Pathfinder/ModelSource/Pathfinder.alp`)
2. In the properties of its RL Experiment, click the export button at the top; save the zip file inside a folder named "ModelExported" to sit alongside the "ModelSource" folder
3. In your file explorer, extract the contents of the zip in place (such that, e.g., the file `examples/Pathfinder/ModelExported/model.jar` is valid)
4. Run the associated Python script
4. Run the associated Python script

0 comments on commit 05fff14

Please sign in to comment.