Skip to content

Commit

Permalink
Clarify remote docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelCourtney committed Sep 5, 2024
1 parent 77df99d commit 2f7ce20
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions procedural/remote/MODULE_DOCS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Module Remote

This library provides tools for accessing plans and simulation results from remote execution environments.
This is intended to allow goal and constraint authors to run their code outside Aerie, and these implementations
do not need to be packaged in the goal and constraint jars.
This is intended to allow goal and constraint authors to run their code locally while remotely interacting
with an Aerie instance. These classes do not need to be packaged inside the jars, and instead should be
imported by a driver that the user implements themselves.

# Package gov.nasa.ammos.aerie.procedural.remote
Remote utilities for running goals and constraints outside of Aerie.
Utilities for using goals and constraints to locally interact with a remote Aerie instance.

0 comments on commit 2f7ce20

Please sign in to comment.