Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ewu63 authored Apr 19, 2020
1 parent 5fb78e3 commit d9ce10f
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,23 @@
pyHyp
=====
# pyHyp
[![Build Status](https://travis-ci.com/mdolab/pyhyp.svg?branch=master)](https://travis-ci.com/mdolab/pyhyp)

pyHyp uses hyperbolic volume mesh marching schemes to extrude structured surface meshes into volume meshes.
pyHyp is used as a preprocessing step in the geometry and mesh-creation process prior to an optimization.

Documentation
-------------
## Documentation

Please see the [documentation](http://mdolab.engin.umich.edu/docs/packages/pyhyp/doc/index.html) for installation details and API documentation.

To locally build the documentation, enter the `doc` folder and enter `make html` in terminal.
You can then view the built documentation in the `_build` folder.


Citation
--------
## Citation

pyHyp is based on the theory presented in "Enhancements of a three-dimensional hyperbolic grid generation scheme."
For more background, theory, and figures, see the original [journal article](https://doi.org/10.1016/0096-3003(92)90073-A).

How pyHyp fits within MACH
--------------------------
## How pyHyp fits within MACH

pyHyp takes structured surface meshes and extrudes them into structured volume meshes.
This is done as a pre-processing step.
Expand All @@ -30,7 +27,6 @@ An example [XDSM](https://github.com/mdolab/pyXDSM) for an optimization setup th

![pySurf XDSM diagram](doc/images/pysurf_xdsm.png)

License
-------
## License

Copyright 2019 MDO Lab. See the LICENSE file for details.

0 comments on commit d9ce10f

Please sign in to comment.