From 02adf8394f625d8ae05f3ff0e83fbf9315a5af1b Mon Sep 17 00:00:00 2001 From: Paul Wilson Date: Fri, 14 Jul 2023 08:33:12 -0500 Subject: [PATCH 1/2] Update README.md Updated Readme with link to dependencies to make them easier to find. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e5a5a8b..dc1edc34 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ -# parametric_stellarator +## 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. + +# Dependencies +This tool depends on [the VMEC tools](https://github.com/aaroncbader/pystell_uw/blob/master/read_vmec.py) developed by @aaroncbader From 0891ac97410727fd1488da8ea705883517c4a9d2 Mon Sep 17 00:00:00 2001 From: Connor Moreno Date: Tue, 18 Jul 2023 15:55:08 -0500 Subject: [PATCH 2/2] Add additional dependencies to README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc1edc34..06f57c10 100644 --- a/README.md +++ b/README.md @@ -1,5 +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 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 +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