Skip to content

Commit

Permalink
Sprint 2: Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
speckdavid committed Sep 27, 2023
1 parent 8c7cc66 commit 358fef3
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,20 @@ git clone [email protected]:speckdavid/unified-planning.git
pip install unified-planning/
```

Then install this package.
Then install this package using pip:
```
pip install up-symk
```

Alternatively, you can install it locally by following these steps:

Ensure you have the necessary packages to build Symk:

```
sudo apt-get -y install cmake g++ make python3 autoconf automake git
```

Clone and build the package.

```
git clone [email protected]:aiplan4eu/up-symk.git
Expand All @@ -34,3 +47,4 @@ pip install up-symk/
In the [notebooks folder](notebooks/), you can find two examples of how to use the SymK planner within the unified planning library.
- [Multi-Solution Generation: Using SymK in the Unified Planning Library](https://github.com/aiplan4eu/up-symk/blob/master/notebooks/symk_usage.ipynb)
- [Optimizing Plan Utility: Using SymK in the Unified Planning Library](https://github.com/aiplan4eu/up-symk/blob/master/notebooks/symk_osp_usage.ipynb)
- [Axioms and Derived Predicates in the Unified Planning Library](https://github.com/speckdavid/up-symk/blob/master/notebooks/axioms_usage.ipynb)

0 comments on commit 358fef3

Please sign in to comment.