You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README.md to include instruction on procedural constraints (#19)
The previous README included outdated instructions on running scheduling procedures and did not include instructions on running constraint procedures. This small update revises the README to have the correct instructions.
Copy file name to clipboardExpand all lines: README.md
+21-11Lines changed: 21 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,42 +46,52 @@ This will create the file `'missionmodel/build/libs/missionmodel.jar`, which you
46
46
47
47
<!-- If you want to just try the model without building it yourself you can [download it here](./missionmodel.jar). -->
48
48
49
-
### Scheduling Procedures
50
-
To build scheduling procedures, first you will need a completed mission model. You can accomplish this by following the [Aerie Mission Modeling Tutorial](https://nasa-ammos.github.io/aerie-docs/tutorials/mission-modeling/introduction/), or by using the included `complete-model-tutorial.patch`:
49
+
### Scheduling Procedures and Constraints
50
+
To build scheduling procedures or procedural constraints, first you will need a completed mission model. You can accomplish this by following the [Aerie Mission Modeling Tutorial](https://nasa-ammos.github.io/aerie-docs/tutorials/mission-modeling/introduction/), or by using the included `complete-model-tutorial.patch`:
51
51
52
52
```sh
53
53
git apply complete-model-tutorial.patch
54
54
```
55
55
56
-
This is required since scheduling procedures will reference activity types (e.g. when placing activity directives), and the model in this repo, out of the box, has no registered activities.
56
+
This is required since these procedures will reference activity types (e.g. when placing activity directives), and the model in this repo, out of the box, has no registered activities.
57
57
58
-
Then, copy an example scheduling procedure into the procedures folder.
58
+
Then, copy an example procedure into the scheduling or constraint procedures folder.
(For a more involved example procedure, take a look at some [procedures in the Aerie repo](https://github.com/NASA-AMMOS/aerie/blob/develop/procedural/examples/foo-procedures/src/main/java/gov/nasa/ammos/aerie/procedural/examples/fooprocedures/procedures/StayWellFed.java))
68
+
(For more involved example procedures, take a look at some [scheduling procedures in the Aerie repo](https://github.com/NASA-AMMOS/aerie/blob/develop/procedural/examples/foo-procedures/src/main/java/gov/nasa/ammos/aerie/procedural/examples/fooprocedures/procedures/StayWellFed.java) and [constraint procedures in the modeling tutorial]())
65
69
66
70
The following will be your process every time you iterate on these procedures
The first `gradle` command will expand `@SchedulingProcedure` annotations into new, verbose source code files that Aerie can process down the line.
83
+
The first `gradle` command will expand `@SchedulingProcedure`or `@ConstraintProcedure`annotations into new, verbose source code files that Aerie can process down the line.
74
84
The second `gradle` command then looks for those generated files, creates a task to build a `.jar` for each file, and then runs all those tasks.
75
85
76
-
Your procedure jars will then be in `scheduling/build/libs/OriginalSourceCodeFileName.jar`, which in this case will be `scheduling/build/libs/SampleProcedure.jar`.
86
+
Your procedure jars will then be in `build/libs/OriginalSourceCodeFileName.jar` of either the `scheduling` or `constraints` directories
77
87
78
88
## Running Procedures
79
89
80
90
Now that you have `.jar`'s, we need to upload them to Aerie so you can run them against plans.
81
91
82
-
The quickest way to upload a single JAR is to use the `aerie-ui`. On the `/scheduling/goals/new` page, you should now see a new tab option for creating a `jar` procedural goal. Once created, you will need to register the goal with a specific plan, just like you do with EDSL goals.
92
+
The quickest way to upload a single JAR is to use the `aerie-ui`. On the `/scheduling/goals/new`or `constraints/new`page, you should now see a new tab option for creating a `jar` procedural goal. Once created, you will need to register the procedure with a specific plan or model, just like you do with EDSL goals.
83
93
84
-
Then, from the manage goals page on your plan, you can pass arguments to your procedure using the drop down menu, and run your procedures using the schedule button. You can also right click to manage invocations (duplicate, delete, etc)
94
+
Then, from the manage goals or constraints page on your plan, you can pass arguments to your procedure using the drop down menu, and run your procedures using the "schedule" or "check constraints" button. You can also right click to manage invocations (duplicate, delete, etc)
0 commit comments