Skip to content

Commit

Permalink
Merge pull request #6 from cnerg/add_link_to_dependencies_in_readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
gonuke authored Jul 19, 2023
2 parents 27c932c + 0891ac9 commit 1e71b04
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1e71b04

Please sign in to comment.