Skip to content

Commit d9ce10f

Browse files
authored
Update README.md
1 parent 5fb78e3 commit d9ce10f

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,23 @@
1-
pyHyp
2-
=====
1+
# pyHyp
2+
[![Build Status](https://travis-ci.com/mdolab/pyhyp.svg?branch=master)](https://travis-ci.com/mdolab/pyhyp)
33

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

7-
Documentation
8-
-------------
7+
## Documentation
98

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

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

1514

16-
Citation
17-
--------
15+
## Citation
1816

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

22-
How pyHyp fits within MACH
23-
--------------------------
20+
## How pyHyp fits within MACH
2421

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

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

33-
License
34-
-------
30+
## License
3531

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

0 commit comments

Comments
 (0)