Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YuXHe15 committed Aug 10, 2023
1 parent c7b65cb commit 3da19cd
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,26 @@ This repository contains a module for creating automated workflows in the contex
After creating the environment using conda, one library have to be installed mannually since neither Pypi nor Conda has the distribution.

```git clone https://github.com/tpaviot/pythonocc-utils.git```
activate the environment if you did not:
```bash
conda activate amworkflow
```

to the root directory and then

```pip install ./pythonocc-utils```

## How to use
Last step, install amworkflow locally:
```bash
pip install .
```

Then you are good to go.

## Get started
This is a simple tutorial which get you familiar with the way of interacting with amworkflow.
1. Create a new folder in /usecase, for example test_am4, as maybe created already.
2. Create a new script am4.py.
2. Create a new script am4.py. (Also maybe in the folder now.)
3. simply do:
```python
from amworkflow.src.interface.api import amWorkflow as aw
Expand Down

0 comments on commit 3da19cd

Please sign in to comment.