Skip to content
Snippets Groups Projects
Commit adf30ecc authored by jilberto's avatar jilberto
Browse files

Adding setup

parent acb96d0c
No related branches found
No related tags found
No related merge requests found
......@@ -5,8 +5,15 @@ Cheart-Python Input/Output
This package provides a python package that can be used to read/write different python files. It also provides a command line utility to convert cheart files to `.vtu`.
# Installation
To install do
To install, first clone the repository
```
git clone https://gitlab.eecs.umich.edu/jilberto/cheart-python-io.git
```
and enter your credentials
Enter the project folder and install
```
cd cheart-python-io
pip install -e .
```
......
......@@ -11,4 +11,33 @@ Description-Content-Type: text/markdown
# cheart-python-io
Cheart-python Input/Output
Cheart-Python Input/Output
This package provides a python package that can be used to read/write different python files. It also provides a command line utility to convert cheart files to `.vtu`.
# Installation
To install, first clone the repository
```
git clone https://gitlab.eecs.umich.edu/jilberto/cheart-python-io.git
```
and enter your credentials
Enter the project folder and install
```
cd cheart-python-io
pip install -e .
```
# Python utility
To use cheartio in a python code do
```
import cheartio
```
# Command line utility
In the command line you can do
```
ch-utils -h
```
to see options.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment