Merge pull request #345 from fusion-energy/improved-usage-intro

updated usage docs

docs/usage.rst

@@ -1,17 +1,25 @@
 Usage
 =====
 
-There are two main reactors to choose from, Tokamak and Spherical Tokamak.
-These can be built with:
-- A radial and vertical build
-- A radial build and plasma elongation.
-
-The former gives the user more control of the size of components allowing reactor blankets to vary both radially and vertically.
-The later allows reactors to be built with a minimal number of parameters.
-In all cases it is possible to add additional components such as divertors, poloidal and toroidal magnets and any self made geometry as a CadQuery Workplane.
+There are two main reactors to choose from:
+
+* Tokamak
+* Spherical Tokamak.
+
 The reactors can be varied in terms of their radial build, vertical build, elongation and triangularity which gives a lot of variability.
-These examples show how to make various reactors with and without different components, each example is minimal and aims to show a single feature, you will have to combine examples to make a complete model. 
+All reactors can be built with either:
+
+* A radial and vertical build which gives more control of the size of components allowing reactor blankets to vary both radially and vertically.
+* A radial build and plasma elongation which assumes the vertical build matches the radial build and allows the reactors to be built with a minimal number of parameters.
+
+It is also easy to add additional components such as:
+
+* divertors
+* poloidal magnets
+* toroidal magnets
+* your own CadQuery shapes / workplanes
 
+These examples show how to make various reactors with different options.
 
 
 .. toctree::

docs/usage_spherical_tokamak.rst

@@ -1,7 +1,7 @@
 Spherical Tokamak
 =================
 
-- This is characterized by a blanket that only goes around the outboard sides of the plasma and the center column has no inboard breeding.
+- This is characterized by a blanket that only goes around the outboard sides of the plasma and a center column that has no inboard breeding.
 
 Spherical tokamak
 -----------------
@@ -135,11 +135,11 @@ Spherical tokamak from plasma
     result.save('reactor.step')
 
 
-Spherical tokamak with divertor(s)
-----------------------------------
+Spherical tokamak with divertor
+-------------------------------
 
-- ll reactors support adding additional radial builds for the lower_divertor and or the upper_divertor.
-- This example adds two divertors to a spherical_tokamak_from_plasma reactor but and other reactor would also work.
+- Reactors support adding additional extra intersect shapes that can be_divertor.
+- This example adds a divertor to a spherical_tokamak_from_plasma reactor.
 
 .. cadquery::
     :gridsize: 0
@@ -152,7 +152,7 @@ Spherical tokamak with divertor(s)
 
     # makes a rectangle that overlaps the lower blanket under the plasma
     # the intersection of this and the layers will form the lower divertor
-    points = [(300, -700), (300, 0), (400, 0), (400, -700)]
+    points = [(200, -700), (200, 0), (300, 0), (300, -700)]
     divertor_lower = Workplane('XZ', origin=(0,0,0)).polyline(points).close().revolve(180)
     result = paramak.spherical_tokamak_from_plasma(
         radial_build=[
@@ -179,7 +179,7 @@ Spherical tokamak with divertor(s)
 
     # makes a rectangle that overlaps the lower blanket under the plasma
     # the intersection of this and the layers will form the lower divertor
-    points = [(300, -700), (300, 0), (400, 0), (400, -700)]
+    points = [(200, -700), (200, 0), (300, 0), (300, -700)]
     divertor_lower = Workplane('XZ', origin=(0,0,0)).polyline(points).close().revolve(180)
     result = paramak.spherical_tokamak_from_plasma(
         radial_build=[

docs/usage_tokamak.rst

@@ -145,8 +145,8 @@ Tokamak from plasma
         rotation_angle=90,
     )
 
-Tokamak with divertor(s)
-------------------------
+Tokamak with divertor
+---------------------
 TODO
 
 Tokamak with poloidal field coils