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 3da19cd commit f45dfe7
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,25 @@
## Motivation

This repository contains a module for creating automated workflows in the context of concrete additive manufacturing.

### Workflow
* parametrized design (defined via CAD program)
* generate geometry file (.stl, .stp)
* generate GCODE --> printer
* generate mesh file (.msh, .xdmf & .h5, .vtk)
* generate FEM simulation

### Built-in file-management
* Management of files generated by the workflow by a file-based database.


### folder structure
* amworkflow: general routines
* tests: pytest for general routines
* usecases: example usecases


## Conda
```conda env create -f environment.yml```

## Installation
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```
```bash
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```
```bash
pip install ./pythonocc-utils
```

Last step, install amworkflow locally:
```bash
pip install .
python -m pip install .
```

Then you are good to go.
Expand Down Expand Up @@ -233,5 +215,23 @@ This is a simple tutorial which get you familiar with the way of interacting wit

For more details and usages of the workflow, check out in wiki.

## Motivation

This repository contains a module for creating automated workflows in the context of concrete additive manufacturing.

### Workflow
* parametrized design (defined via CAD program)
* generate geometry file (.stl, .stp)
* generate GCODE --> printer
* generate mesh file (.msh, .xdmf & .h5, .vtk)
* generate FEM simulation

### Built-in file-management
* Management of files generated by the workflow by a file-based database.


### folder structure
* amworkflow: general routines
* tests: pytest for general routines
* usecases: example usecases

0 comments on commit f45dfe7

Please sign in to comment.