Skip to content

Commit 60bb4a2

Browse files
committed
update Aerie -> PlanDev/SeqDev in README and user-facing strings
1 parent 8aa43e8 commit 60bb4a2

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

.env.template

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
REPOSITORY_DOCKER_URL=ghcr.io/nasa-ammos
22

3-
# choose a specific Aerie version
3+
# choose a specific PlanDev version
44
DOCKER_TAG=v3.8.0
55

66
GITHUB_USER=

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Aerie Template
1+
# PlanDev Template
22

3-
This repo provides a basic template for getting started with mission modeling and scheduling within the Aerie framework.
3+
This repo provides a basic template for getting started with mission modeling and scheduling within the PlanDev framework.
44

5-
Included in this repo is all the basic infrastructure and scaffolding required to generate a mission model `.jar` file, as well as scheduling procedure `.jar`s that can be uploaded and run within Aerie.
5+
Included in this repo is all the basic infrastructure and scaffolding required to generate a mission model `.jar` file, as well as scheduling procedure `.jar`s that can be uploaded and run within PlanDev.
66

77
#### Interested in learning how to develop a model yourself?
8-
Check out the [Aerie Mission Modeling Tutorial](https://nasa-ammos.github.io/aerie-docs/tutorials/mission-modeling/introduction/)
8+
Check out the [PlanDev Mission Modeling Tutorial](https://nasa-ammos.github.io/plandev-docs/tutorials/mission-modeling/introduction/)
99

1010
#### Looking for some example models to play around with?
1111
Try out the following models:
@@ -21,7 +21,7 @@ Try out the following models:
2121
brew install --cask temurin@21
2222
```
2323

24-
First you need to create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) in your GitHub account that includes `read-packages` scope) so you can download the Aerie Maven packages from the [GitHub Maven package registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry).
24+
First you need to create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) in your GitHub account that includes `read-packages` scope) so you can download the PlanDev Maven packages from the [GitHub Maven package registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry).
2525

2626
Then, copy the `.env.template` file to `.env`. This `.env` file will hold your `GITHUB_TOKEN` and `GITHUB_USER` variables. Note that this file is "`.gitignore`d" by default, so edits to this file won't be tracked in version control.
2727

@@ -42,12 +42,12 @@ To build a mission model JAR you can do:
4242
./gradlew :missionmodel:build --refresh-dependencies
4343
```
4444

45-
This will create the file `'missionmodel/build/libs/missionmodel.jar`, which you can upload to Aerie using the UI or API.
45+
This will create the file `'missionmodel/build/libs/missionmodel.jar`, which you can upload to PlanDev using the UI or API.
4646

4747
<!-- If you want to just try the model without building it yourself you can [download it here](./missionmodel.jar). -->
4848

4949
### 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`:
50+
To build scheduling procedures or procedural constraints, first you will need a completed mission model. You can accomplish this by following the [PlanDev Mission Modeling Tutorial](https://nasa-ammos.github.io/plandev-docs/tutorials/mission-modeling/introduction/), or by using the included `complete-model-tutorial.patch`:
5151

5252
```sh
5353
git apply complete-model-tutorial.patch
@@ -65,7 +65,7 @@ or
6565
cp constraints/examples/SampleActivityConstraint.java scheduling/src/main/java/constraints/procedures
6666
```
6767

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]())
68+
(For more involved example procedures, take a look at some [scheduling procedures in the PlanDev 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]())
6969

7070
The following will be your process every time you iterate on these procedures
7171

@@ -80,16 +80,16 @@ or
8080
./gradlew constraints:buildAllProcedureJars
8181
```
8282

83-
The first `gradle` command will expand `@SchedulingProcedure` or `@ConstraintProcedure` 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 PlanDev can process down the line.
8484
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.
8585

8686
Your procedure jars will then be in `build/libs/OriginalSourceCodeFileName.jar` of either the `scheduling` or `constraints` directories
8787

8888
## Running Procedures
8989

90-
Now that you have `.jar`'s, we need to upload them to Aerie so you can run them against plans.
90+
Now that you have `.jar`'s, we need to upload them to PlanDev so you can run them against plans.
9191

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.
92+
The quickest way to upload a single JAR is to use the PlanDev 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.
9393

9494
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)
9595

0 commit comments

Comments
 (0)