diff --git a/dev/.buildinfo b/dev/.buildinfo index 4c56ad67..7305bd10 100644 --- a/dev/.buildinfo +++ b/dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 4cfaa513d45b7aa87a9de63a833128ef +config: 34847df8f38610551642295d687ccd8b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/dev/.doctrees/environment.pickle b/dev/.doctrees/environment.pickle index a6e3f44c..4700219a 100644 Binary files a/dev/.doctrees/environment.pickle and b/dev/.doctrees/environment.pickle differ diff --git a/dev/.doctrees/index.doctree b/dev/.doctrees/index.doctree index 83a45a20..219a146d 100644 Binary files a/dev/.doctrees/index.doctree and b/dev/.doctrees/index.doctree differ diff --git a/dev/_modules/index.html b/dev/_modules/index.html index 5ae1077b..d3f2aa15 100644 --- a/dev/_modules/index.html +++ b/dev/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — Paramak 0.1.dev1+g131100a documentation + Overview: module code — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/assemblies/spherical_tokamak.html b/dev/_modules/paramak/assemblies/spherical_tokamak.html index 81166514..fe00fdf3 100644 --- a/dev/_modules/paramak/assemblies/spherical_tokamak.html +++ b/dev/_modules/paramak/assemblies/spherical_tokamak.html @@ -7,7 +7,7 @@ - paramak.assemblies.spherical_tokamak — Paramak 0.1.dev1+g131100a documentation + paramak.assemblies.spherical_tokamak — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/assemblies/tokamak.html b/dev/_modules/paramak/assemblies/tokamak.html index 8518c4b7..07aedcfc 100644 --- a/dev/_modules/paramak/assemblies/tokamak.html +++ b/dev/_modules/paramak/assemblies/tokamak.html @@ -7,7 +7,7 @@ - paramak.assemblies.tokamak — Paramak 0.1.dev1+g131100a documentation + paramak.assemblies.tokamak — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/blanket_from_plasma.html b/dev/_modules/paramak/workplanes/blanket_from_plasma.html index 477fe463..51724fc3 100644 --- a/dev/_modules/paramak/workplanes/blanket_from_plasma.html +++ b/dev/_modules/paramak/workplanes/blanket_from_plasma.html @@ -7,7 +7,7 @@ - paramak.workplanes.blanket_from_plasma — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.blanket_from_plasma — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/center_column_shield_cylinder.html b/dev/_modules/paramak/workplanes/center_column_shield_cylinder.html index 032d2bea..1b03a572 100644 --- a/dev/_modules/paramak/workplanes/center_column_shield_cylinder.html +++ b/dev/_modules/paramak/workplanes/center_column_shield_cylinder.html @@ -7,7 +7,7 @@ - paramak.workplanes.center_column_shield_cylinder — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.center_column_shield_cylinder — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/constant_thickness_dome.html b/dev/_modules/paramak/workplanes/constant_thickness_dome.html index 3d22d69e..3590fa7d 100644 --- a/dev/_modules/paramak/workplanes/constant_thickness_dome.html +++ b/dev/_modules/paramak/workplanes/constant_thickness_dome.html @@ -7,7 +7,7 @@ - paramak.workplanes.constant_thickness_dome — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.constant_thickness_dome — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/cutting_wedge.html b/dev/_modules/paramak/workplanes/cutting_wedge.html index cbac7b1b..43dfc7b0 100644 --- a/dev/_modules/paramak/workplanes/cutting_wedge.html +++ b/dev/_modules/paramak/workplanes/cutting_wedge.html @@ -7,7 +7,7 @@ - paramak.workplanes.cutting_wedge — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.cutting_wedge — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/dished_vacuum_vessel.html b/dev/_modules/paramak/workplanes/dished_vacuum_vessel.html index e9addba1..777761c9 100644 --- a/dev/_modules/paramak/workplanes/dished_vacuum_vessel.html +++ b/dev/_modules/paramak/workplanes/dished_vacuum_vessel.html @@ -7,7 +7,7 @@ - paramak.workplanes.dished_vacuum_vessel — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.dished_vacuum_vessel — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/plasma_simplified.html b/dev/_modules/paramak/workplanes/plasma_simplified.html index 46b27ff7..e425c0e8 100644 --- a/dev/_modules/paramak/workplanes/plasma_simplified.html +++ b/dev/_modules/paramak/workplanes/plasma_simplified.html @@ -7,7 +7,7 @@ - paramak.workplanes.plasma_simplified — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.plasma_simplified — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/poloidal_field_coil.html b/dev/_modules/paramak/workplanes/poloidal_field_coil.html index ea4ab26c..18504e30 100644 --- a/dev/_modules/paramak/workplanes/poloidal_field_coil.html +++ b/dev/_modules/paramak/workplanes/poloidal_field_coil.html @@ -7,7 +7,7 @@ - paramak.workplanes.poloidal_field_coil — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.poloidal_field_coil — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/poloidal_field_coil_case.html b/dev/_modules/paramak/workplanes/poloidal_field_coil_case.html index dfe66a67..4c6d1b20 100644 --- a/dev/_modules/paramak/workplanes/poloidal_field_coil_case.html +++ b/dev/_modules/paramak/workplanes/poloidal_field_coil_case.html @@ -7,7 +7,7 @@ - paramak.workplanes.poloidal_field_coil_case — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.poloidal_field_coil_case — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/toroidal_field_coil_rectangle.html b/dev/_modules/paramak/workplanes/toroidal_field_coil_rectangle.html index fe1197b9..f7a82e03 100644 --- a/dev/_modules/paramak/workplanes/toroidal_field_coil_rectangle.html +++ b/dev/_modules/paramak/workplanes/toroidal_field_coil_rectangle.html @@ -7,7 +7,7 @@ - paramak.workplanes.toroidal_field_coil_rectangle — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.toroidal_field_coil_rectangle — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_modules/paramak/workplanes/u_shaped_dome.html b/dev/_modules/paramak/workplanes/u_shaped_dome.html index bd241115..83b20067 100644 --- a/dev/_modules/paramak/workplanes/u_shaped_dome.html +++ b/dev/_modules/paramak/workplanes/u_shaped_dome.html @@ -7,7 +7,7 @@ - paramak.workplanes.u_shaped_dome — Paramak 0.1.dev1+g131100a documentation + paramak.workplanes.u_shaped_dome — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js index bc5471af..0abaa1f8 100644 --- a/dev/_static/documentation_options.js +++ b/dev/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.1.dev1+g131100a', + VERSION: '0.1.dev1+ge1316d5', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/dev/genindex.html b/dev/genindex.html index ff22bd82..1491c37d 100644 --- a/dev/genindex.html +++ b/dev/genindex.html @@ -7,7 +7,7 @@ - Index — Paramak 0.1.dev1+g131100a documentation + Index — Paramak 0.1.dev1+ge1316d5 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/index.html b/dev/index.html index 6f3cf97f..561bda0c 100644 --- a/dev/index.html +++ b/dev/index.html @@ -8,7 +8,7 @@ - Paramak documentation — Paramak 0.1.dev1+g131100a documentation + Paramak documentation — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - + @@ -378,7 +378,7 @@

Paramak documentation#

-

Version: 0.1.dev1+g131100a

+

Version: 0.1.dev1+ge1316d5

Parameter driven CAD creation for fusion reactors.

Paramak provides parameter driven creation of Tokamak and Spherical Tokamak CAD models as well as DAGMC compatible neutronics models.

The style of reaction, sizes of components, plasma shape and number of radial or vertical layers can be specified,

diff --git a/dev/install.html b/dev/install.html index 5c72ab91..99755bea 100644 --- a/dev/install.html +++ b/dev/install.html @@ -8,7 +8,7 @@ - Install — Paramak 0.1.dev1+g131100a documentation + Install — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - + diff --git a/dev/objects.inv b/dev/objects.inv index 441542a6..b0c76a1e 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ diff --git a/dev/python_api.html b/dev/python_api.html index 7643df84..bab808f6 100644 --- a/dev/python_api.html +++ b/dev/python_api.html @@ -8,7 +8,7 @@ - Python API reference — Paramak 0.1.dev1+g131100a documentation + Python API reference — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - + diff --git a/dev/search.html b/dev/search.html index 1ebbc4a2..f3bf1c29 100644 --- a/dev/search.html +++ b/dev/search.html @@ -6,7 +6,7 @@ - Search - Paramak 0.1.dev1+g131100a documentation + Search - Paramak 0.1.dev1+ge1316d5 documentation @@ -34,7 +34,7 @@ - + diff --git a/dev/searchindex.js b/dev/searchindex.js index 2d5f8ecf..6d0af9d7 100644 --- a/dev/searchindex.js +++ b/dev/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Assemblies": [[2, "assemblies"]], "Developer Installation": [[1, "developer-installation"]], "Install": [[1, null]], "Install (conda)": [[1, "install-conda"]], "Install (mamba)": [[1, "install-mamba"]], "Paramak documentation": [[0, null]], "Prerequisites": [[1, "prerequisites"]], "Python API reference": [[2, null]], "Spherical Tokamak": [[4, null]], "Spherical tokamak": [[4, "id1"]], "Spherical tokamak from plasma": [[4, "spherical-tokamak-from-plasma"]], "Spherical tokamak with divertor": [[4, "spherical-tokamak-with-divertor"]], "Spherical tokamak with negative triangularity": [[4, "spherical-tokamak-with-negative-triangularity"]], "Spherical tokamak with poloidal field coils": [[4, "spherical-tokamak-with-poloidal-field-coils"]], "Spherical tokamak with toroidal field coils": [[4, "spherical-tokamak-with-toroidal-field-coils"]], "Tokamak": [[5, null], [5, "id1"]], "Tokamak from plasma": [[5, "tokamak-from-plasma"]], "Tokamak with divertor": [[5, "tokamak-with-divertor"]], "Tokamak with negative triangularity": [[5, "tokamak-with-negative-triangularity"]], "Tokamak with poloidal field coils": [[5, "tokamak-with-poloidal-field-coils"]], "Tokamak with several customizations": [[5, "tokamak-with-several-customizations"]], "Tokamak with toroidal field coils": [[5, "tokamak-with-toroidal-field-coils"]], "Usage": [[3, null]], "Visualization options": [[6, null]], "Workplanes": [[2, "workplanes"]]}, "docnames": ["index", "install", "python_api", "usage", "usage_spherical_tokamak", "usage_tokamak", "usage_vis"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "install.rst", "python_api.rst", "usage.rst", "usage_spherical_tokamak.rst", "usage_tokamak.rst", "usage_vis.rst"], "indexentries": {"blanket_from_plasma() (in module paramak)": [[2, "paramak.blanket_from_plasma", false]], "center_column_shield_cylinder() (in module paramak)": [[2, "paramak.center_column_shield_cylinder", false]], "constant_thickness_dome() (in module paramak)": [[2, "paramak.constant_thickness_dome", false]], "cutting_wedge() (in module paramak)": [[2, "paramak.cutting_wedge", false]], "dished_vacuum_vessel() (in module paramak)": [[2, "paramak.dished_vacuum_vessel", false]], "plasma_simplified() (in module paramak)": [[2, "paramak.plasma_simplified", false]], "poloidal_field_coil() (in module paramak)": [[2, "paramak.poloidal_field_coil", false]], "poloidal_field_coil_case() (in module paramak)": [[2, "paramak.poloidal_field_coil_case", false]], "spherical_tokamak() (in module paramak)": [[2, "paramak.spherical_tokamak", false]], "spherical_tokamak_from_plasma() (in module paramak)": [[2, "paramak.spherical_tokamak_from_plasma", false]], "tokamak() (in module paramak)": [[2, "paramak.tokamak", false]], "tokamak_from_plasma() (in module paramak)": [[2, "paramak.tokamak_from_plasma", false]], "toroidal_field_coil_rectangle() (in module paramak)": [[2, "paramak.toroidal_field_coil_rectangle", false]], "u_shaped_dome() (in module paramak)": [[2, "paramak.u_shaped_dome", false]]}, "objects": {"paramak": [[2, 0, 1, "", "blanket_from_plasma"], [2, 0, 1, "", "center_column_shield_cylinder"], [2, 0, 1, "", "constant_thickness_dome"], [2, 0, 1, "", "cutting_wedge"], [2, 0, 1, "", "dished_vacuum_vessel"], [2, 0, 1, "", "plasma_simplified"], [2, 0, 1, "", "poloidal_field_coil"], [2, 0, 1, "", "poloidal_field_coil_case"], [2, 0, 1, "", "spherical_tokamak"], [2, 0, 1, "", "spherical_tokamak_from_plasma"], [2, 0, 1, "", "tokamak"], [2, 0, 1, "", "tokamak_from_plasma"], [2, 0, 1, "", "toroidal_field_coil_rectangle"], [2, 0, 1, "", "u_shaped_dome"]]}, "objnames": {"0": ["py", "function", "Python function"]}, "objtypes": {"0": "py:function"}, "terms": {"0": [0, 2, 4, 5, 6], "1": [0, 2], "10": [2, 4, 5], "100": [2, 4], "11": 1, "120": [4, 5], "15": [2, 4, 5], "150": [2, 4, 5], "16": 2, "180": [2, 4, 5], "2": [2, 4, 5], "20": [2, 4, 5], "200": [2, 4], "235": 5, "24": 6, "270": 4, "3": [1, 2], "30": [2, 4, 5], "300": [2, 4, 5], "310": 2, "333": 2, "350": 2, "360": 2, "370": 5, "3d": 6, "4": 2, "40": [4, 5], "400": [2, 5], "450": 2, "498": 2, "5": 4, "50": [2, 4, 5], "500": 4, "520": [4, 5], "55": [2, 4, 5], "560": 4, "60": [4, 5], "600": 4, "610": 4, "650": 5, "70": 4, "700": [4, 5], "730": 5, "80": [4, 5], "810": 5, "860": 5, "90": [2, 4, 5], "A": [2, 3], "For": 2, "If": [1, 2], "In": [2, 4], "It": 3, "The": [0, 2, 3, 4, 5, 6], "Then": 1, "There": 3, "These": 3, "To": 1, "_description_": 2, "_summary_": 2, "_type_": 2, "abov": 1, "activ": 1, "ad": 4, "add": [3, 4], "addit": [3, 4], "all": [1, 3, 4], "allow": [2, 3, 4, 5, 6], "allow_overlapping_shap": 2, "also": [2, 3, 4, 6], "anaconda": 1, "angl": 2, "ani": [4, 5], "anti": 2, "api": 0, "append": [4, 5], "ar": [3, 4], "argument": [2, 4, 5], "around": [2, 4, 5], "assembli": [0, 6], "assum": 3, "avail": 4, "axi": 2, "azimuth": 2, "azimuth_start_angl": 2, "azimuthal_placement_angl": [2, 4, 5], "base": 2, "be_divertor": 4, "between": 2, "blanket": [2, 3, 4, 5], "blanket_from_plasma": [0, 2], "both": 3, "breed": 4, "brep": 6, "browser": 6, "build": [2, 3, 4, 5], "built": [3, 6], "c": 1, "cad": [0, 6], "cadqueri": [1, 2, 3, 4, 5, 6], "callabl": 2, "can": [0, 2, 3, 4, 5, 6], "case": 2, "case_thick": [4, 5], "casing_thick": [2, 4, 5], "cd": 1, "center": [2, 4], "center_column_shield_cylind": [0, 2], "center_point": [2, 4, 5], "centr": 2, "character": [4, 5], "choos": 3, "chord": 2, "chord_center_height": 2, "chord_height": 2, "chord_width": 2, "circl": 2, "circumfer": 2, "clock": 2, "clockwis": 2, "clone": 1, "close": [4, 5], "cm": 2, "coil": [0, 2, 3], "coil_height": [2, 4, 5], "coil_width": [2, 4, 5], "color": 2, "column": [2, 4], "com": 1, "combin": 5, "compat": 0, "compon": [0, 2, 3, 6], "conda": 0, "connect_to_cent": 2, "constant": 2, "constant_thickness_dom": [0, 2], "contain": 2, "continu": 5, "contribut": 1, "control": [2, 3], "coordin": 2, "cover": 1, "creat": [1, 2, 4, 5], "creation": 0, "curv": 2, "custom": [0, 3], "cut": 2, "cutting_wedg": [0, 2], "cylinder_height": 2, "cylindr": 2, "dagmc": 0, "default": 2, "degre": 2, "depend": 1, "describ": 2, "descript": 2, "dev1": 0, "develop": 0, "differ": [3, 4, 5], "direct": 2, "dish": 2, "dish_height": 2, "dished_vacuum_vessel": [0, 2], "dished_vessel": 2, "distanc": [2, 4, 5], "divertor": [0, 3], "divertor_low": [4, 5], "document": 6, "dome": 2, "doubl": 2, "downgrad": 6, "download": 1, "driven": 0, "dynam": 1, "e": [1, 4], "easi": 3, "either": [2, 3], "elong": [2, 3, 4, 5], "energi": 1, "environ": 1, "exampl": [2, 3, 4, 5, 6], "export": [2, 6], "export_html": 6, "extra": [2, 4, 5], "extra_cut_shap": [2, 4, 5], "extra_intersect_shap": [2, 4, 5], "extrus": 2, "f": [4, 5], "fals": 2, "faster": 1, "favorit": 6, "few": 5, "field": [0, 2, 3], "file": 6, "filenam": 2, "first": [2, 6], "flang": 2, "float": 2, "forg": 1, "form": [4, 5], "freecad": 6, "from": [0, 1, 2, 3, 6], "function": [2, 4, 5], "fusion": [0, 1, 2], "g": 4, "g131100a": 0, "gap": [4, 5], "geometri": 2, "git": 1, "github": 1, "give": 3, "goe": [4, 5], "graph": 2, "ha": [2, 4], "have": 1, "head": 2, "height": [2, 4, 5], "horizont": 2, "horizontal_start_point": [2, 4, 5], "how": 3, "html": 6, "http": 1, "i": [1, 2, 3, 4, 5, 6], "import": [1, 4, 5, 6], "inboard": [4, 5], "includ": [1, 2, 6], "increas": 2, "inform": 6, "inner": 2, "inner_radiu": 2, "instal": [0, 6], "interact": 6, "interpol": 2, "intersect": [2, 4, 5], "itself": 2, "jupyt": 6, "jupyter_cadqueri": 6, "keep": [4, 5], "knuckl": 2, "kwarg": 2, "layer": [0, 4, 5], "layertyp": [4, 5], "leg": 2, "legend": 2, "less": 1, "linear": 2, "linearli": 2, "list": 2, "long": 2, "lot": 3, "lower": [2, 4, 5], "m": 6, "made": 2, "magnet": 3, "main": 3, "major": 2, "major_radiu": 2, "make": [2, 3, 4, 5], "mamba": 0, "mani": 5, "manner": 1, "match": 3, "measur": 2, "meet": 2, "method": 1, "mid": 2, "might": [1, 2, 6], "miniconda": 1, "miniforg": 1, "minim": [3, 4], "minor": 2, "minor_radiu": 2, "model": [0, 2], "more": [1, 3, 6], "my_reactor": 5, "name": [1, 2], "navig": 1, "need": [1, 6], "neg": [0, 2, 3], "nessecari": 2, "neutron": 0, "new": 1, "none": 2, "now": 1, "null": 2, "num_point": 2, "number": [0, 2, 3, 6], "numer": 2, "o": 2, "obj": 2, "object": [2, 6], "offset": 2, "offset_from_plasma": 2, "onc": 1, "one": 4, "onli": [4, 5], "open": 6, "option": [0, 1, 2, 3], "origin": [2, 4, 5], "other": [4, 6], "outboard": [4, 5], "outer": 2, "overlap": [2, 4, 5], "own": 3, "packag": [1, 6], "paramak": [1, 2, 4, 5], "paramak_env": 1, "paramet": [0, 2, 3], "parametr": [4, 5], "pf": [4, 5], "pip": [1, 6], "placement": 2, "plane": 2, "plasma": [0, 2, 3], "plasma_simplifi": [0, 2], "point": [2, 4, 5], "poloid": [0, 2, 3], "poloidal_field_coil": [0, 2, 4, 5], "poloidal_field_coil_cas": [0, 2, 4, 5], "polylin": [4, 5], "portabl": 6, "posit": 2, "prefer": 1, "prefix": 2, "prerequisit": 0, "proce": 1, "procedur": 1, "produc": [2, 5], "provid": [0, 4, 5], "pure": 1, "python": [0, 1, 6], "r1": 4, "r2": 4, "radial": [0, 2, 3, 4, 5], "radial_build": [2, 4, 5], "radiu": 2, "ram": 1, "reaction": 0, "reactor": [0, 2, 3, 4, 5, 6], "readi": 1, "recommend": 1, "rectangl": [4, 5], "rectangular": 2, "refer": 0, "reference_point": 2, "repositori": 1, "repres": 2, "requir": [1, 4, 5], "result": [2, 4, 5, 6], "result2": 4, "return": [2, 6], "revolv": [4, 5], "rotat": 2, "rotation_angl": [2, 4, 5], "same": [4, 5], "save": [4, 5, 6], "section": 2, "sector": 2, "see": 6, "separ": [4, 5], "sequenc": [2, 4], "set": [4, 5], "sever": [0, 3], "shape": [0, 2, 3, 4, 5], "shield": 2, "should": 1, "show": [3, 6], "side": [4, 5], "similar": 4, "simpl": 2, "size": [0, 3], "softwar": 6, "solid": [4, 5], "sourc": 2, "specif": 1, "specifi": 0, "spheric": [0, 3], "spherical_tokamak": [0, 2, 4, 5], "spherical_tokamak_from_plasma": [0, 2, 4], "spherical_tokamak_from_plasma_with_pf_magnet": 4, "spherical_tokamak_minim": 4, "spherical_tokamak_with_princeton_tf": 4, "spherical_tokamak_with_rectangular_tf": 4, "start": 2, "start_angl": 2, "step": [1, 4, 5, 6], "stl": 6, "stop": 2, "stop_angl": 2, "str": 2, "straight": 2, "style": [0, 2], "support": 4, "surfac": 2, "tank": 2, "te": 2, "term": 3, "termin": 1, "tf": [2, 4, 5], "tf_style_1": 4, "tf_style_2": 4, "than": [1, 2], "them": 6, "thi": [1, 2, 4, 5, 6], "thick": [2, 4, 5], "thin": 2, "todo": 5, "togeth": [2, 5], "tokamak": [0, 2, 3], "tokamak_from_plasma": [0, 2, 5], "tokamak_minim": 5, "tokamak_plasma": 2, "tokamak_with_custom": 5, "tool": 6, "toroid": [0, 2, 3], "toroidal_field_coil": 2, "toroidal_field_coil_princeton_d": 4, "toroidal_field_coil_rectangl": [0, 2, 4, 5], "triangular": [0, 2, 3], "true": [2, 4, 5], "tupl": 2, "two": [2, 3], "type": 2, "u": 2, "u_shaped_dom": [0, 2], "under": [4, 5], "upper": 2, "upper_or_low": 2, "us": [1, 2, 4, 6], "usag": 0, "vacuum": 2, "valu": [2, 4, 5], "vari": [2, 3], "variabl": 3, "variou": 3, "version": [0, 1], "vertic": [0, 2, 3, 4, 5], "vertical_build": [2, 4, 5], "vertical_displac": 2, "vertical_mid_point": [2, 4, 5], "vessel": 2, "vi": 6, "view": 6, "visual": [0, 3], "volum": 2, "wai": [4, 6], "want": 1, "web": 6, "wedg": 2, "well": 0, "when": 2, "where": 6, "which": [2, 3, 4, 5, 6], "width": [2, 4, 5], "with_inner_leg": [2, 4, 5], "within": 1, "work": [4, 5], "workplan": [0, 3, 4, 5, 6], "would": [4, 5], "x": 2, "xz": [2, 4, 5], "you": 1, "your": [1, 3, 6], "z": 2, "zip": [4, 5]}, "titles": ["Paramak documentation", "Install", "Python API reference", "Usage", "Spherical Tokamak", "Tokamak", "Visualization options"], "titleterms": {"api": 2, "assembli": 2, "coil": [4, 5], "conda": 1, "custom": 5, "develop": 1, "divertor": [4, 5], "document": 0, "field": [4, 5], "from": [4, 5], "instal": 1, "mamba": 1, "neg": [4, 5], "option": 6, "paramak": 0, "plasma": [4, 5], "poloid": [4, 5], "prerequisit": 1, "python": 2, "refer": 2, "sever": 5, "spheric": 4, "tokamak": [4, 5], "toroid": [4, 5], "triangular": [4, 5], "usag": 3, "visual": 6, "workplan": 2}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Assemblies": [[2, "assemblies"]], "Developer Installation": [[1, "developer-installation"]], "Install": [[1, null]], "Install (conda)": [[1, "install-conda"]], "Install (mamba)": [[1, "install-mamba"]], "Paramak documentation": [[0, null]], "Prerequisites": [[1, "prerequisites"]], "Python API reference": [[2, null]], "Spherical Tokamak": [[4, null]], "Spherical tokamak": [[4, "id1"]], "Spherical tokamak from plasma": [[4, "spherical-tokamak-from-plasma"]], "Spherical tokamak with divertor": [[4, "spherical-tokamak-with-divertor"]], "Spherical tokamak with negative triangularity": [[4, "spherical-tokamak-with-negative-triangularity"]], "Spherical tokamak with poloidal field coils": [[4, "spherical-tokamak-with-poloidal-field-coils"]], "Spherical tokamak with toroidal field coils": [[4, "spherical-tokamak-with-toroidal-field-coils"]], "Tokamak": [[5, null], [5, "id1"]], "Tokamak from plasma": [[5, "tokamak-from-plasma"]], "Tokamak with divertor": [[5, "tokamak-with-divertor"]], "Tokamak with negative triangularity": [[5, "tokamak-with-negative-triangularity"]], "Tokamak with poloidal field coils": [[5, "tokamak-with-poloidal-field-coils"]], "Tokamak with several customizations": [[5, "tokamak-with-several-customizations"]], "Tokamak with toroidal field coils": [[5, "tokamak-with-toroidal-field-coils"]], "Usage": [[3, null]], "Visualization options": [[6, null]], "Workplanes": [[2, "workplanes"]]}, "docnames": ["index", "install", "python_api", "usage", "usage_spherical_tokamak", "usage_tokamak", "usage_vis"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "install.rst", "python_api.rst", "usage.rst", "usage_spherical_tokamak.rst", "usage_tokamak.rst", "usage_vis.rst"], "indexentries": {"blanket_from_plasma() (in module paramak)": [[2, "paramak.blanket_from_plasma", false]], "center_column_shield_cylinder() (in module paramak)": [[2, "paramak.center_column_shield_cylinder", false]], "constant_thickness_dome() (in module paramak)": [[2, "paramak.constant_thickness_dome", false]], "cutting_wedge() (in module paramak)": [[2, "paramak.cutting_wedge", false]], "dished_vacuum_vessel() (in module paramak)": [[2, "paramak.dished_vacuum_vessel", false]], "plasma_simplified() (in module paramak)": [[2, "paramak.plasma_simplified", false]], "poloidal_field_coil() (in module paramak)": [[2, "paramak.poloidal_field_coil", false]], "poloidal_field_coil_case() (in module paramak)": [[2, "paramak.poloidal_field_coil_case", false]], "spherical_tokamak() (in module paramak)": [[2, "paramak.spherical_tokamak", false]], "spherical_tokamak_from_plasma() (in module paramak)": [[2, "paramak.spherical_tokamak_from_plasma", false]], "tokamak() (in module paramak)": [[2, "paramak.tokamak", false]], "tokamak_from_plasma() (in module paramak)": [[2, "paramak.tokamak_from_plasma", false]], "toroidal_field_coil_rectangle() (in module paramak)": [[2, "paramak.toroidal_field_coil_rectangle", false]], "u_shaped_dome() (in module paramak)": [[2, "paramak.u_shaped_dome", false]]}, "objects": {"paramak": [[2, 0, 1, "", "blanket_from_plasma"], [2, 0, 1, "", "center_column_shield_cylinder"], [2, 0, 1, "", "constant_thickness_dome"], [2, 0, 1, "", "cutting_wedge"], [2, 0, 1, "", "dished_vacuum_vessel"], [2, 0, 1, "", "plasma_simplified"], [2, 0, 1, "", "poloidal_field_coil"], [2, 0, 1, "", "poloidal_field_coil_case"], [2, 0, 1, "", "spherical_tokamak"], [2, 0, 1, "", "spherical_tokamak_from_plasma"], [2, 0, 1, "", "tokamak"], [2, 0, 1, "", "tokamak_from_plasma"], [2, 0, 1, "", "toroidal_field_coil_rectangle"], [2, 0, 1, "", "u_shaped_dome"]]}, "objnames": {"0": ["py", "function", "Python function"]}, "objtypes": {"0": "py:function"}, "terms": {"0": [0, 2, 4, 5, 6], "1": [0, 2], "10": [2, 4, 5], "100": [2, 4], "11": 1, "120": [4, 5], "15": [2, 4, 5], "150": [2, 4, 5], "16": 2, "180": [2, 4, 5], "2": [2, 4, 5], "20": [2, 4, 5], "200": [2, 4], "235": 5, "24": 6, "270": 4, "3": [1, 2], "30": [2, 4, 5], "300": [2, 4, 5], "310": 2, "333": 2, "350": 2, "360": 2, "370": 5, "3d": 6, "4": 2, "40": [4, 5], "400": [2, 5], "450": 2, "498": 2, "5": 4, "50": [2, 4, 5], "500": 4, "520": [4, 5], "55": [2, 4, 5], "560": 4, "60": [4, 5], "600": 4, "610": 4, "650": 5, "70": 4, "700": [4, 5], "730": 5, "80": [4, 5], "810": 5, "860": 5, "90": [2, 4, 5], "A": [2, 3], "For": 2, "If": [1, 2], "In": [2, 4], "It": 3, "The": [0, 2, 3, 4, 5, 6], "Then": 1, "There": 3, "These": 3, "To": 1, "_description_": 2, "_summary_": 2, "_type_": 2, "abov": 1, "activ": 1, "ad": 4, "add": [3, 4], "addit": [3, 4], "all": [1, 3, 4], "allow": [2, 3, 4, 5, 6], "allow_overlapping_shap": 2, "also": [2, 3, 4, 6], "anaconda": 1, "angl": 2, "ani": [4, 5], "anti": 2, "api": 0, "append": [4, 5], "ar": [3, 4], "argument": [2, 4, 5], "around": [2, 4, 5], "assembli": [0, 6], "assum": 3, "avail": 4, "axi": 2, "azimuth": 2, "azimuth_start_angl": 2, "azimuthal_placement_angl": [2, 4, 5], "base": 2, "be_divertor": 4, "between": 2, "blanket": [2, 3, 4, 5], "blanket_from_plasma": [0, 2], "both": 3, "breed": 4, "brep": 6, "browser": 6, "build": [2, 3, 4, 5], "built": [3, 6], "c": 1, "cad": [0, 6], "cadqueri": [1, 2, 3, 4, 5, 6], "callabl": 2, "can": [0, 2, 3, 4, 5, 6], "case": 2, "case_thick": [4, 5], "casing_thick": [2, 4, 5], "cd": 1, "center": [2, 4], "center_column_shield_cylind": [0, 2], "center_point": [2, 4, 5], "centr": 2, "character": [4, 5], "choos": 3, "chord": 2, "chord_center_height": 2, "chord_height": 2, "chord_width": 2, "circl": 2, "circumfer": 2, "clock": 2, "clockwis": 2, "clone": 1, "close": [4, 5], "cm": 2, "coil": [0, 2, 3], "coil_height": [2, 4, 5], "coil_width": [2, 4, 5], "color": 2, "column": [2, 4], "com": 1, "combin": 5, "compat": 0, "compon": [0, 2, 3, 6], "conda": 0, "connect_to_cent": 2, "constant": 2, "constant_thickness_dom": [0, 2], "contain": 2, "continu": 5, "contribut": 1, "control": [2, 3], "coordin": 2, "cover": 1, "creat": [1, 2, 4, 5], "creation": 0, "curv": 2, "custom": [0, 3], "cut": 2, "cutting_wedg": [0, 2], "cylinder_height": 2, "cylindr": 2, "dagmc": 0, "default": 2, "degre": 2, "depend": 1, "describ": 2, "descript": 2, "dev1": 0, "develop": 0, "differ": [3, 4, 5], "direct": 2, "dish": 2, "dish_height": 2, "dished_vacuum_vessel": [0, 2], "dished_vessel": 2, "distanc": [2, 4, 5], "divertor": [0, 3], "divertor_low": [4, 5], "document": 6, "dome": 2, "doubl": 2, "downgrad": 6, "download": 1, "driven": 0, "dynam": 1, "e": [1, 4], "easi": 3, "either": [2, 3], "elong": [2, 3, 4, 5], "energi": 1, "environ": 1, "exampl": [2, 3, 4, 5, 6], "export": [2, 6], "export_html": 6, "extra": [2, 4, 5], "extra_cut_shap": [2, 4, 5], "extra_intersect_shap": [2, 4, 5], "extrus": 2, "f": [4, 5], "fals": 2, "faster": 1, "favorit": 6, "few": 5, "field": [0, 2, 3], "file": 6, "filenam": 2, "first": [2, 6], "flang": 2, "float": 2, "forg": 1, "form": [4, 5], "freecad": 6, "from": [0, 1, 2, 3, 6], "function": [2, 4, 5], "fusion": [0, 1, 2], "g": 4, "gap": [4, 5], "ge1316d5": 0, "geometri": 2, "git": 1, "github": 1, "give": 3, "goe": [4, 5], "graph": 2, "ha": [2, 4], "have": 1, "head": 2, "height": [2, 4, 5], "horizont": 2, "horizontal_start_point": [2, 4, 5], "how": 3, "html": 6, "http": 1, "i": [1, 2, 3, 4, 5, 6], "import": [1, 4, 5, 6], "inboard": [4, 5], "includ": [1, 2, 6], "increas": 2, "inform": 6, "inner": 2, "inner_radiu": 2, "instal": [0, 6], "interact": 6, "interpol": 2, "intersect": [2, 4, 5], "itself": 2, "jupyt": 6, "jupyter_cadqueri": 6, "keep": [4, 5], "knuckl": 2, "kwarg": 2, "layer": [0, 4, 5], "layertyp": [4, 5], "leg": 2, "legend": 2, "less": 1, "linear": 2, "linearli": 2, "list": 2, "long": 2, "lot": 3, "lower": [2, 4, 5], "m": 6, "made": 2, "magnet": 3, "main": 3, "major": 2, "major_radiu": 2, "make": [2, 3, 4, 5], "mamba": 0, "mani": 5, "manner": 1, "match": 3, "measur": 2, "meet": 2, "method": 1, "mid": 2, "might": [1, 2, 6], "miniconda": 1, "miniforg": 1, "minim": [3, 4], "minor": 2, "minor_radiu": 2, "model": [0, 2], "more": [1, 3, 6], "my_reactor": 5, "name": [1, 2], "navig": 1, "need": [1, 6], "neg": [0, 2, 3], "nessecari": 2, "neutron": 0, "new": 1, "none": 2, "now": 1, "null": 2, "num_point": 2, "number": [0, 2, 3, 6], "numer": 2, "o": 2, "obj": 2, "object": [2, 6], "offset": 2, "offset_from_plasma": 2, "onc": 1, "one": 4, "onli": [4, 5], "open": 6, "option": [0, 1, 2, 3], "origin": [2, 4, 5], "other": [4, 6], "outboard": [4, 5], "outer": 2, "overlap": [2, 4, 5], "own": 3, "packag": [1, 6], "paramak": [1, 2, 4, 5], "paramak_env": 1, "paramet": [0, 2, 3], "parametr": [4, 5], "pf": [4, 5], "pip": [1, 6], "placement": 2, "plane": 2, "plasma": [0, 2, 3], "plasma_simplifi": [0, 2], "point": [2, 4, 5], "poloid": [0, 2, 3], "poloidal_field_coil": [0, 2, 4, 5], "poloidal_field_coil_cas": [0, 2, 4, 5], "polylin": [4, 5], "portabl": 6, "posit": 2, "prefer": 1, "prefix": 2, "prerequisit": 0, "proce": 1, "procedur": 1, "produc": [2, 5], "provid": [0, 4, 5], "pure": 1, "python": [0, 1, 6], "r1": 4, "r2": 4, "radial": [0, 2, 3, 4, 5], "radial_build": [2, 4, 5], "radiu": 2, "ram": 1, "reaction": 0, "reactor": [0, 2, 3, 4, 5, 6], "readi": 1, "recommend": 1, "rectangl": [4, 5], "rectangular": 2, "refer": 0, "reference_point": 2, "repositori": 1, "repres": 2, "requir": [1, 4, 5], "result": [2, 4, 5, 6], "result2": 4, "return": [2, 6], "revolv": [4, 5], "rotat": 2, "rotation_angl": [2, 4, 5], "same": [4, 5], "save": [4, 5, 6], "section": 2, "sector": 2, "see": 6, "separ": [4, 5], "sequenc": [2, 4], "set": [4, 5], "sever": [0, 3], "shape": [0, 2, 3, 4, 5], "shield": 2, "should": 1, "show": [3, 6], "side": [4, 5], "similar": 4, "simpl": 2, "size": [0, 3], "softwar": 6, "solid": [4, 5], "sourc": 2, "specif": 1, "specifi": 0, "spheric": [0, 3], "spherical_tokamak": [0, 2, 4, 5], "spherical_tokamak_from_plasma": [0, 2, 4], "spherical_tokamak_from_plasma_with_pf_magnet": 4, "spherical_tokamak_minim": 4, "spherical_tokamak_with_princeton_tf": 4, "spherical_tokamak_with_rectangular_tf": 4, "start": 2, "start_angl": 2, "step": [1, 4, 5, 6], "stl": 6, "stop": 2, "stop_angl": 2, "str": 2, "straight": 2, "style": [0, 2], "support": 4, "surfac": 2, "tank": 2, "te": 2, "term": 3, "termin": 1, "tf": [2, 4, 5], "tf_style_1": 4, "tf_style_2": 4, "than": [1, 2], "them": 6, "thi": [1, 2, 4, 5, 6], "thick": [2, 4, 5], "thin": 2, "todo": 5, "togeth": [2, 5], "tokamak": [0, 2, 3], "tokamak_from_plasma": [0, 2, 5], "tokamak_minim": 5, "tokamak_plasma": 2, "tokamak_with_custom": 5, "tool": 6, "toroid": [0, 2, 3], "toroidal_field_coil": 2, "toroidal_field_coil_princeton_d": 4, "toroidal_field_coil_rectangl": [0, 2, 4, 5], "triangular": [0, 2, 3], "true": [2, 4, 5], "tupl": 2, "two": [2, 3], "type": 2, "u": 2, "u_shaped_dom": [0, 2], "under": [4, 5], "upper": 2, "upper_or_low": 2, "us": [1, 2, 4, 6], "usag": 0, "vacuum": 2, "valu": [2, 4, 5], "vari": [2, 3], "variabl": 3, "variou": 3, "version": [0, 1], "vertic": [0, 2, 3, 4, 5], "vertical_build": [2, 4, 5], "vertical_displac": 2, "vertical_mid_point": [2, 4, 5], "vessel": 2, "vi": 6, "view": 6, "visual": [0, 3], "volum": 2, "wai": [4, 6], "want": 1, "web": 6, "wedg": 2, "well": 0, "when": 2, "where": 6, "which": [2, 3, 4, 5, 6], "width": [2, 4, 5], "with_inner_leg": [2, 4, 5], "within": 1, "work": [4, 5], "workplan": [0, 3, 4, 5, 6], "would": [4, 5], "x": 2, "xz": [2, 4, 5], "you": 1, "your": [1, 3, 6], "z": 2, "zip": [4, 5]}, "titles": ["Paramak documentation", "Install", "Python API reference", "Usage", "Spherical Tokamak", "Tokamak", "Visualization options"], "titleterms": {"api": 2, "assembli": 2, "coil": [4, 5], "conda": 1, "custom": 5, "develop": 1, "divertor": [4, 5], "document": 0, "field": [4, 5], "from": [4, 5], "instal": 1, "mamba": 1, "neg": [4, 5], "option": 6, "paramak": 0, "plasma": [4, 5], "poloid": [4, 5], "prerequisit": 1, "python": 2, "refer": 2, "sever": 5, "spheric": 4, "tokamak": [4, 5], "toroid": [4, 5], "triangular": [4, 5], "usag": 3, "visual": 6, "workplan": 2}}) \ No newline at end of file diff --git a/dev/usage.html b/dev/usage.html index 8587bf49..92fa1a8f 100644 --- a/dev/usage.html +++ b/dev/usage.html @@ -8,7 +8,7 @@ - Usage — Paramak 0.1.dev1+g131100a documentation + Usage — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - + diff --git a/dev/usage_spherical_tokamak.html b/dev/usage_spherical_tokamak.html index 2e94d706..e86c11e3 100644 --- a/dev/usage_spherical_tokamak.html +++ b/dev/usage_spherical_tokamak.html @@ -8,7 +8,7 @@ - Spherical Tokamak — Paramak 0.1.dev1+g131100a documentation + Spherical Tokamak — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - + diff --git a/dev/usage_tokamak.html b/dev/usage_tokamak.html index e80592ff..1da0fcb5 100644 --- a/dev/usage_tokamak.html +++ b/dev/usage_tokamak.html @@ -8,7 +8,7 @@ - Tokamak — Paramak 0.1.dev1+g131100a documentation + Tokamak — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - + diff --git a/dev/usage_vis.html b/dev/usage_vis.html index 03e2d451..419d946b 100644 --- a/dev/usage_vis.html +++ b/dev/usage_vis.html @@ -8,7 +8,7 @@ - Visualization options — Paramak 0.1.dev1+g131100a documentation + Visualization options — Paramak 0.1.dev1+ge1316d5 documentation @@ -36,7 +36,7 @@ - +