diff --git a/README.md b/README.md index 1e5a5a8b..06f57c10 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ -# parametric_stellarator -Parametric 3D CAD model of a stellarator fusion device. This toolset takes VMEC plasma equilibrium data and builds a blanket with layers of uniform thickness from a user-specified radial build. +## parametric_stellarator +Parametric 3D CAD modeling tool for stellarator fusion devices. This toolset takes VMEC plasma equilibrium data to build a blanket with components of uniform thickness from a user-specified radial build, as well as corresponding coil filament point-locus data to build magnet coils of user-specified cross-section. + +# Dependencies +This tool depends on: + +- [The VMEC tools](https://github.com/aaroncbader/pystell_uw/blob/master/read_vmec.py) developed by @aaroncbader +- [CadQuery](https://cadquery.readthedocs.io/en/latest/installation.html) +- [MOAB](https://bitbucket.org/fathomteam/moab/src/master/) +- [Coreform Cubit](https://coreform.com/products/downloads/) or [Cubit](https://cubit.sandia.gov/downloads/) by Sandia National Laboratories