diff --git a/dev/.buildinfo b/dev/.buildinfo index d40fdce7..3bac78ad 100644 --- a/dev/.buildinfo +++ b/dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9e88068194cab21ac08d9626ae99d1eb +config: c34c7b21d7652bf4b64e9eb542072277 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/dev/.doctrees/developer_guide.doctree b/dev/.doctrees/developer_guide.doctree index 3ccb6b4b..285e976a 100644 Binary files a/dev/.doctrees/developer_guide.doctree and b/dev/.doctrees/developer_guide.doctree differ diff --git a/dev/.doctrees/environment.pickle b/dev/.doctrees/environment.pickle index c91449cc..0ae2b4ac 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 1a479439..ce0bf603 100644 Binary files a/dev/.doctrees/index.doctree and b/dev/.doctrees/index.doctree differ diff --git a/dev/_modules/geouned/GEOReverse/core.html b/dev/_modules/geouned/GEOReverse/core.html index ff2bbc36..9bea34e3 100644 --- a/dev/_modules/geouned/GEOReverse/core.html +++ b/dev/_modules/geouned/GEOReverse/core.html @@ -7,7 +7,7 @@ - geouned.GEOReverse.core — GEOUNED 0.1.dev1+gf7f4279 documentation + geouned.GEOReverse.core — GEOUNED 0.1.dev1+ge242565 documentation @@ -34,7 +34,7 @@ - + diff --git a/dev/_modules/geouned/GEOUNED/core.html b/dev/_modules/geouned/GEOUNED/core.html index abea3f07..9c3b068b 100644 --- a/dev/_modules/geouned/GEOUNED/core.html +++ b/dev/_modules/geouned/GEOUNED/core.html @@ -7,7 +7,7 @@ - geouned.GEOUNED.core — GEOUNED 0.1.dev1+gf7f4279 documentation + geouned.GEOUNED.core — GEOUNED 0.1.dev1+ge242565 documentation @@ -34,7 +34,7 @@ - + diff --git a/dev/_modules/geouned/GEOUNED/utils/data_classes.html b/dev/_modules/geouned/GEOUNED/utils/data_classes.html index b5077462..18ccdfd8 100644 --- a/dev/_modules/geouned/GEOUNED/utils/data_classes.html +++ b/dev/_modules/geouned/GEOUNED/utils/data_classes.html @@ -7,7 +7,7 @@ - geouned.GEOUNED.utils.data_classes — GEOUNED 0.1.dev1+gf7f4279 documentation + geouned.GEOUNED.utils.data_classes — GEOUNED 0.1.dev1+ge242565 documentation @@ -34,7 +34,7 @@ - + diff --git a/dev/_modules/index.html b/dev/_modules/index.html index 63586d78..639b4aa5 100644 --- a/dev/_modules/index.html +++ b/dev/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — GEOUNED 0.1.dev1+gf7f4279 documentation + Overview: module code — GEOUNED 0.1.dev1+ge242565 documentation @@ -34,7 +34,7 @@ - + diff --git a/dev/_sources/developer_guide.rst.txt b/dev/_sources/developer_guide.rst.txt index 4442c148..7190c6b5 100644 --- a/dev/_sources/developer_guide.rst.txt +++ b/dev/_sources/developer_guide.rst.txt @@ -168,7 +168,14 @@ Tests checking the code will run automatically on the pull request. If the tests pass and at least one approver approves then the pull request can be merged. -When a pull request is ready to be merged then the pull request should be **squashed** and merged into the dev branch. +When updating the dev branch from a feature branch then a pull request is should be merged in with the **squashed and merged*** option. + +When updating the main branch from the dev branch then the pull request should be merged in with the **create a merge commit** option. + +Version numbering +~~~~~~~~~~~~~~~~~ + +GEOUNED will use Semantic Versioning to number releases of the tool, in the form "Major.Minor.Patch", e.g., “3.15.9”. Releasing a new version ~~~~~~~~~~~~~~~~~~~~~~~ @@ -214,7 +221,7 @@ For example adding version 1.2.3 would look like this Then create a `pull request from dev branch to main branch `_ -Once the tests for this pass then merge the pull request in. **Do not squash** this pull request as we want to keep the history of the version changes. +Once the tests for this pass then merge the pull request in. Use the **create a merge commit** option when merging this pull request from dev to main. Then `create a new release on the main branch `_ with the version number and a description of the changes. @@ -235,17 +242,12 @@ Conda Forge Releasing The conda-forge package release is done after the PyPI release. This is because the conda-forge package is built from the PyPI package. -Conda Forge has a bot thew generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released. +Conda Forge has a bot that generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released. -The pull request will be generated in the `conda-forge/GEOUNED-feedstock `_ repository. +The pull request will be generated in the `conda-forge/GEOUNED-feedstock `_ repository a short while after the PyPI release. Check the pull request and if the tests pass then merge the pull request. A Conda Forge package will be built and released to the conda-forge channel. -Once released the package will be visaible on the `conda-forge channel `_. - -Version Numbering -~~~~~~~~~~~~~~~~~ - -GEOUNED will use Semantic Versioning to number releases of the tool, in the form "Major.Minor.Patch", e.g., “3.15.9”. +Once released the package will be visible on the `conda-forge channel `_. diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js index 64ce9a61..99738188 100644 --- a/dev/_static/documentation_options.js +++ b/dev/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.1.dev1+gf7f4279', + VERSION: '0.1.dev1+ge242565', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/dev/developer_guide.html b/dev/developer_guide.html index 6c44df37..19389dc5 100644 --- a/dev/developer_guide.html +++ b/dev/developer_guide.html @@ -8,7 +8,7 @@ - Developer guide — GEOUNED 0.1.dev1+gf7f4279 documentation + Developer guide — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + @@ -541,7 +541,12 @@

Merging a pull requestsPull requests should be made from feature branches on a fork of the repository to the dev branch.

Tests checking the code will run automatically on the pull request.

If the tests pass and at least one approver approves then the pull request can be merged.

-

When a pull request is ready to be merged then the pull request should be squashed and merged into the dev branch.

+

When updating the dev branch from a feature branch then a pull request is should be merged in with the squashed and merged* option.

+

When updating the main branch from the dev branch then the pull request should be merged in with the create a merge commit option.

+ +
+

Version numbering#

+

GEOUNED will use Semantic Versioning to number releases of the tool, in the form “Major.Minor.Patch”, e.g., “3.15.9”.

Releasing a new version#

@@ -581,7 +586,7 @@

Releasing a new version

Then create a pull request from dev branch to main branch

-

Once the tests for this pass then merge the pull request in. Do not squash this pull request as we want to keep the history of the version changes.

+

Once the tests for this pass then merge the pull request in. Use the create a merge commit option when merging this pull request from dev to main.

Then create a new release on the main branch with the version number and a description of the changes.

Create a new tag with the version number (e.g. 1.2.3) and the release name (e.g. v1.2.3) and the release description.

Press the Generate release notes button to get the release notes from the pull request descriptions.

@@ -594,15 +599,11 @@

Releasing a new version

Conda Forge Releasing#

The conda-forge package release is done after the PyPI release. This is because the conda-forge package is built from the PyPI package.

-

Conda Forge has a bot thew generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released.

-

The pull request will be generated in the conda-forge/GEOUNED-feedstock repository.

+

Conda Forge has a bot that generates a pull request to update the conda-forge recipe. This is done automatically when the PyPI package is released.

+

The pull request will be generated in the conda-forge/GEOUNED-feedstock repository a short while after the PyPI release.

Check the pull request and if the tests pass then merge the pull request.

A Conda Forge package will be built and released to the conda-forge channel.

-

Once released the package will be visaible on the conda-forge channel.

-

-
-

Version Numbering#

-

GEOUNED will use Semantic Versioning to number releases of the tool, in the form “Major.Minor.Patch”, e.g., “3.15.9”.

+

Once released the package will be visible on the conda-forge channel.

@@ -647,9 +648,9 @@

Version NumberingBuilding the docs locally
  • Running the tests locally
  • Merging a pull requests
    • +
  • Version numbering
  • Releasing a new version
  • Conda Forge Releasing
    • -
  • Version Numbering
    • diff --git a/dev/genindex.html b/dev/genindex.html index a0d1c4d5..b96c0034 100644 --- a/dev/genindex.html +++ b/dev/genindex.html @@ -7,7 +7,7 @@ - Index — GEOUNED 0.1.dev1+gf7f4279 documentation + Index — GEOUNED 0.1.dev1+ge242565 documentation @@ -34,7 +34,7 @@ - + diff --git a/dev/index.html b/dev/index.html index 5229e2d8..4a2667a7 100644 --- a/dev/index.html +++ b/dev/index.html @@ -8,7 +8,7 @@ - Geouned Documentation — GEOUNED 0.1.dev1+gf7f4279 documentation + Geouned Documentation — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + @@ -397,7 +397,7 @@

    Geouned Documentation#

    -

    Version: 0.1.dev1+gf7f4279

    +

    Version: 0.1.dev1+ge242565

    GEOUNED converts CAD to Constructive Solid Geometry (CSG) formats for use in Monte Carlo transport codes. Supported codes include OpenMC, PHITS, Serpent and MCNP.

    @@ -446,9 +446,9 @@

    Geouned DocumentationBuilding the docs locally
  • Running the tests locally
  • Merging a pull requests
    • +
  • Version numbering
  • Releasing a new version
  • Conda Forge Releasing
    • -
  • Version Numbering
    • diff --git a/dev/install/index.html b/dev/install/index.html index 567da220..82a012cf 100644 --- a/dev/install/index.html +++ b/dev/install/index.html @@ -8,7 +8,7 @@ - Install — GEOUNED 0.1.dev1+gf7f4279 documentation + Install — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/install/install_linux.html b/dev/install/install_linux.html index 6e59c2f2..45d20adf 100644 --- a/dev/install/install_linux.html +++ b/dev/install/install_linux.html @@ -8,7 +8,7 @@ - 1. Linux — GEOUNED 0.1.dev1+gf7f4279 documentation + 1. Linux — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/install/install_windows.html b/dev/install/install_windows.html index 8783581d..858188f9 100644 --- a/dev/install/install_windows.html +++ b/dev/install/install_windows.html @@ -8,7 +8,7 @@ - 2. Windows — GEOUNED 0.1.dev1+gf7f4279 documentation + 2. Windows — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/methodology.html b/dev/methodology.html index d6ea44c1..e5d41714 100644 --- a/dev/methodology.html +++ b/dev/methodology.html @@ -8,7 +8,7 @@ - Methodology — GEOUNED 0.1.dev1+gf7f4279 documentation + Methodology — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/objects.inv b/dev/objects.inv index ada1cc4e..9bc42a95 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 43a5aacb..10ff7ec1 100644 --- a/dev/python_api.html +++ b/dev/python_api.html @@ -8,7 +8,7 @@ - Python API reference — GEOUNED 0.1.dev1+gf7f4279 documentation + Python API reference — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/search.html b/dev/search.html index 8a5bba8c..d328b917 100644 --- a/dev/search.html +++ b/dev/search.html @@ -6,7 +6,7 @@ - Search - GEOUNED 0.1.dev1+gf7f4279 documentation + Search - GEOUNED 0.1.dev1+ge242565 documentation @@ -33,7 +33,7 @@ - + diff --git a/dev/searchindex.js b/dev/searchindex.js index 7861b03d..a32d0c05 100644 --- a/dev/searchindex.js +++ b/dev/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Building the docs locally": [[0, "building-the-docs-locally"]], "Command Line Tool Usage, CAD to CSG conversion": [[9, "command-line-tool-usage-cad-to-csg-conversion"]], "Command Line Tool Usage, CSG to CAD conversion": [[11, "command-line-tool-usage-csg-to-cad-conversion"]], "Conda Forge Releasing": [[0, "conda-forge-releasing"]], "Developer guide": [[0, "developer-guide"]], "Developer install with Mamba": [[0, "developer-install-with-mamba"]], "Geouned Documentation": [[1, "geouned-documentation"]], "Install": [[2, "install"]], "Linux": [[3, "linux"]], "Merging a pull requests": [[0, "merging-a-pull-requests"]], "Methodology": [[5, "methodology"]], "Python API reference": [[6, "python-api-reference"]], "Python Package Usage, CAD to CSG conversion": [[8, "python-package-usage-cad-to-csg-conversion"]], "Python Package Usage, CSG to CAD conversion": [[10, "python-package-usage-csg-to-cad-conversion"]], "Releasing a new version": [[0, "releasing-a-new-version"]], "Running the tests locally": [[0, "running-the-tests-locally"]], "Usage": [[7, "usage"]], "User install with Conda": [[3, "user-install-with-conda"], [4, "user-install-with-conda"]], "User install with Mamba (recommended)": [[3, "user-install-with-mamba-recommended"], [4, "user-install-with-mamba-recommended"]], "Version Numbering": [[0, "version-numbering"]], "Windows": [[4, "windows"]]}, "docnames": ["developer_guide", "index", "install/index", "install/install_linux", "install/install_windows", "methodology", "python_api", "usage/index", "usage/python_cadtocsg_api_usage", "usage/python_cadtocsg_cli_usage", "usage/python_csgtocad_api_usage", "usage/python_csgtocad_cli_usage"], "envversion": {"sphinx": 61, "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": ["developer_guide.rst", "index.rst", "install/index.rst", "install/install_linux.rst", "install/install_windows.rst", "methodology.rst", "python_api.rst", "usage/index.rst", "usage/python_cadtocsg_api_usage.rst", "usage/python_cadtocsg_cli_usage.rst", "usage/python_csgtocad_api_usage.rst", "usage/python_csgtocad_cli_usage.rst"], "indexentries": {"cadtocsg (class in geouned)": [[6, "geouned.CadToCsg", false]], "csgtocad (class in geouned)": [[6, "geouned.CsgToCad", false]], "export_cad() (geouned.csgtocad method)": [[6, "geouned.CsgToCad.export_cad", false]], "export_csg() (geouned.cadtocsg method)": [[6, "geouned.CadToCsg.export_csg", false]], "from_json() (geouned.cadtocsg class method)": [[6, "geouned.CadToCsg.from_json", false]], "load_step_file() (geouned.cadtocsg method)": [[6, "geouned.CadToCsg.load_step_file", false]], "numericformat (class in geouned)": [[6, "geouned.NumericFormat", false]], "options (class in geouned)": [[6, "geouned.Options", false]], "settings (class in geouned)": [[6, "geouned.Settings", false]], "tolerances (class in geouned)": [[6, "geouned.Tolerances", false]]}, "objects": {"geouned": [[6, 0, 1, "", "CadToCsg"], [6, 0, 1, "", "CsgToCad"], [6, 0, 1, "", "NumericFormat"], [6, 0, 1, "", "Options"], [6, 0, 1, "", "Settings"], [6, 0, 1, "", "Tolerances"]], "geouned.CadToCsg": [[6, 1, 1, "", "export_csg"], [6, 1, 1, "", "from_json"], [6, 1, 1, "", "load_step_file"]], "geouned.CsgToCad": [[6, 1, 1, "", "export_cad"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"]}, "objtypes": {"0": "py:class", "1": "py:method"}, "terms": {"": [0, 6], "0": [0, 1, 5, 6, 8, 9, 10, 11], "000001": 8, "0001": [6, 8, 9], "01": [6, 8, 9], "06": [6, 9], "0e": 6, "1": [0, 1, 6, 8, 9], "10": 6, "100": 6, "1000": [6, 10, 11], "1001": 6, "11": [0, 3, 4, 6], "12": 6, "12f": [6, 8, 9], "13": [6, 8, 9], "14": [6, 8, 9], "15": 0, "15f": [6, 8, 9], "18": [6, 8, 9], "1e": [6, 9], "1m": 6, "1mm": 6, "2": [0, 6, 8, 9, 10], "200": [6, 8, 9], "3": [0, 3, 4, 6, 10], "30": [6, 8, 9], "4": [6, 10], "5": 6, "50": [6, 8, 9], "500": 10, "6": 6, "6e": [6, 8, 9], "7": 6, "7e": [6, 8, 9], "87": 6, "9": [0, 6], "A": [0, 6], "As": 0, "For": [0, 6, 8, 9, 11], "If": [0, 6, 8, 10], "In": 6, "It": [0, 3, 4, 6], "No": 6, "The": [0, 2, 6, 8, 9, 10, 11], "Then": [0, 3, 4, 9, 11], "There": [0, 2, 3, 4, 5, 8, 10], "These": 9, "To": 0, "_": 0, "_build": 0, "_description_": 6, "abl": [0, 3, 4], "accept": 6, "action": 0, "activ": [0, 3, 4], "ad": 0, "add": 0, "addit": [0, 6], "adjac": 6, "after": [0, 6], "air": 6, "algorithm": 6, "align": 6, "all": [0, 6, 11], "allow": 6, "along": 6, "also": [0, 2, 3, 4, 6, 8, 11], "altern": 6, "an": [0, 6, 11], "anaconda": [3, 4], "ancillari": 6, "angl": [6, 8, 9], "ani": 6, "apex": 6, "api": [1, 7, 8, 9, 10, 11], "approv": 0, "ar": [0, 2, 3, 4, 5, 6, 8, 10, 11], "area": 6, "argument": [6, 8, 9, 10, 11], "assign": 6, "associ": 6, "assum": [0, 8, 9, 11], "attribut": [6, 8, 9, 10, 11], "automat": [0, 6], "avail": [0, 4, 6], "awai": 0, "ax": 6, "axi": 6, "b": [0, 3, 6], "base": [0, 3, 6], "bash": [0, 3], "becaus": 0, "being": [6, 8, 9, 10, 11], "below": [0, 3, 4, 6, 8, 9, 10, 11], "between": [2, 6], "bin": 3, "bool": 6, "boolean": 6, "boptool": 6, "bot": 0, "both": [0, 11], "bound": 6, "boundari": 6, "bounding_box": [6, 10, 11], "box": [0, 6], "bracket": 6, "branch": 0, "browser": 0, "build": 1, "built": 0, "button": 0, "c": [0, 3, 4, 6], "c_r": [6, 8, 9], "c_xyz": [6, 8, 9], "cad": [1, 6, 7], "cad_from_csg": [6, 11], "cadtocsg": [1, 6, 8], "calcul": [0, 6], "call": [6, 8, 9, 11], "can": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11], "card": 6, "carlo": [1, 6], "carri": 6, "case": [0, 6, 8, 9, 10, 11], "cd": 0, "cell": 6, "cell_rang": [6, 10, 11], "cell_range_typ": [6, 10, 11], "cellcommentfil": [6, 8, 9], "cellsummaryfil": [6, 8, 9], "center": 6, "central": 2, "challeng": 2, "chang": [0, 6, 8, 10], "channel": 0, "check": [0, 6], "checkout": 0, "ci": 0, "class": [6, 8, 9, 10, 11], "classmethod": 6, "cli": 7, "click": 0, "clone": 0, "close": [9, 11], "cm": 6, "cmd": 2, "code": [0, 1, 6], "coeffici": 6, "com": [0, 3, 4], "command": [0, 1, 3, 4, 7, 8], "comment": 6, "comparison": 6, "complementari": 6, "complet": [2, 4, 8, 9, 11], "complic": 2, "compound": 6, "compsolid": [6, 8, 9], "conda": [1, 2], "cone": 6, "config": [6, 8, 9, 11], "config_mcnp": 11, "config_openmc": 11, "configur": [8, 9, 11], "conform": 2, "connect": 2, "consid": 6, "constraint": 6, "construct": [1, 8, 10], "contain": [6, 9, 11], "content": [9, 11], "convers": [1, 6, 7], "convert": [1, 5, 6, 8, 9, 10, 11], "converted_with_geoun": 6, "coordin": 6, "copi": 0, "correct": 0, "could": 0, "creat": [0, 3, 4, 6, 9, 11], "csg": [1, 6, 7], "csg_file": 11, "csg_format": [6, 10, 11], "csgtocad": [1, 6, 10], "cuboid": [8, 9], "curl": [0, 3], "current": [0, 2, 3, 6, 9, 11], "cut": 6, "cyl_angl": [6, 8, 9], "cyl_dist": [6, 8, 9], "cylind": 6, "cylinder_box": [10, 11], "d": 6, "data": 5, "data_class": 6, "debug": [6, 8, 9], "decompos": 6, "decomposit": 6, "default": [0, 6, 8, 9, 10, 11], "defin": 6, "definit": 6, "delet": 6, "dellastnumb": [6, 8, 9], "depend": [0, 2], "describ": 10, "descript": [0, 9, 11], "desir": [6, 8, 10], "determin": 6, "dev": 0, "dev1": 1, "develop": 1, "directori": [0, 8, 9, 11], "distanc": [6, 8, 9], "distribut": [0, 3, 4], "do": 0, "doc": [1, 5], "document": [5, 8, 9, 10, 11], "don": 0, "done": [0, 6], "download": [0, 3, 4], "dummi": 6, "dummymat": [6, 8, 9], "dure": 6, "e": [0, 2], "each": [6, 9, 11], "edg": 6, "edit": 0, "effect": 6, "enclosur": 6, "encompass": 6, "enlarg": 6, "enlargebox": [6, 8, 9], "ensur": 0, "entir": 6, "entri": 0, "environ": [0, 3, 4], "equal": 6, "evalu": 6, "everi": [8, 9, 10, 11], "ex": 4, "exactli": 6, "exampl": [0, 6, 8, 9, 10, 11], "exclud": [6, 10], "execut": [4, 6, 9, 11], "export": 6, "export_cad": [1, 6, 10, 11], "export_csg": [1, 6, 8, 9], "export_to_csg": 6, "exportsolid": [6, 8, 9], "extract": 6, "face": 6, "facet": [6, 8, 9], "fals": [6, 8, 9], "faster": [0, 6], "fcstd": 6, "featur": 0, "feedstock": 0, "fetch": 2, "few": [0, 3, 4, 10], "file": [0, 6, 8, 9, 10, 11], "filenam": [6, 8, 9], "filenotfounderror": 6, "first": [0, 3, 4, 6, 9, 11], "float": 6, "follow": [0, 3, 4, 8, 9, 10, 11], "forc": 6, "forcecylind": [6, 8, 9], "forcenooverlap": [6, 8, 9], "forg": [1, 3, 4], "fork": [0, 2], "form": [0, 6], "format": [1, 5, 6, 8, 11], "former": 6, "found": 6, "freecad": [0, 2, 6, 8, 10], "from": [0, 3, 4, 6, 8], "from_json": [1, 6, 8], "frrecad": 2, "full": [6, 9, 11], "fuller": [3, 4], "function": [0, 6], "fuzzi": 6, "g": 0, "gener": [0, 6], "geo": [8, 10], "geometri": [1, 6, 8, 10], "geometrynam": [6, 8, 9], "geoun": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "geouned_cadtocsg": [0, 3, 4, 9], "geouned_csgtocad": 11, "get": [0, 2, 4, 6, 9], "gf7f4279": 1, "gh": 0, "git": [0, 2], "github": [0, 3, 4], "go": 0, "gq": 6, "gq_10": [6, 8, 9], "gq_1to6": [6, 8, 9], "gq_7to9": [6, 8, 9], "group": 6, "guid": 1, "ha": [0, 2, 6], "had": 2, "happen": 6, "have": [0, 2, 6, 8, 9, 10, 11], "help": [0, 3, 4], "here": [0, 3, 4, 9, 11], "highest": 6, "histori": 0, "how": [2, 6], "howev": [0, 2], "html": 0, "http": [0, 3, 4], "i": [0, 2, 3, 4, 6, 8, 9, 10, 11], "id": 6, "implic": 2, "import": [0, 3, 4, 8, 10], "inbuilt": 2, "includ": [0, 1, 3, 4, 6], "independ": 6, "index": [0, 6], "individu": 0, "inform": 6, "init": 3, "input": 6, "input_filenam": [6, 10, 11], "insid": 6, "instal": [1, 8, 10], "instanc": 6, "instead": [0, 6], "instruct": [0, 3, 4], "int": 6, "integr": 2, "interfac": [8, 9, 11], "interpret": 0, "invalid": 6, "involv": 6, "io": 0, "issu": 6, "its": 6, "join": 6, "json": [0, 6, 8, 9, 11], "k": 0, "k_tan2": [6, 8, 9], "k_xyz": [6, 8, 9], "keep": 0, "kei": [0, 6], "keyword": [9, 11], "kne_angl": [6, 8, 9], "kne_dist": [6, 8, 9], "l": [0, 3], "label": 6, "last": 6, "latest": [0, 3, 4], "least": 0, "left": 6, "level": 6, "level_max": [6, 11], "librari": 2, "like": 0, "line": [0, 1, 3, 4, 7, 8], "link": [0, 4], "linux": [0, 1, 2], "list": [2, 6], "load": [6, 8], "load_step_fil": [1, 6, 8, 9], "local": 1, "locat": 6, "logic": 6, "look": [0, 6], "m": [0, 3], "made": 0, "mai": 6, "main": [0, 2, 8, 10], "major": [0, 6], "make": [0, 2, 8, 10], "mamba": [1, 2], "mani": 8, "manner": 2, "mat_dens": 6, "mat_descript": 6, "mat_label": 6, "mat_rang": [6, 11], "mat_range_typ": [6, 11], "match": [6, 9, 11], "materi": 6, "matfil": [6, 8, 9], "maxbracket": [6, 8, 9], "maximum": 6, "maxsurf": [6, 8, 9], "mcnp": [1, 6, 8, 9, 11], "menu": 4, "merg": 1, "method": [2, 6, 9, 10, 11], "methodologi": 1, "might": 0, "millimet": 6, "min_area": [6, 8, 9], "miniconda": [3, 4], "miniconda3": [3, 4], "miniforg": [0, 3, 4], "miniforge3": [0, 3, 4], "minim": [8, 9, 10, 11], "minimum": 6, "minor": [0, 6], "minvoids": [6, 8, 9], "mkdir": 3, "mm": 6, "model": 6, "modul": 6, "mont": [1, 6], "more": [0, 2, 6, 8], "most": [6, 8, 9, 10, 11], "multipl": 6, "multipli": 6, "must": 2, "mx": 6, "my_new_featur": 0, "my_numeric_format": 8, "my_opt": 8, "my_set": 8, "my_toler": 8, "name": [0, 3, 4, 6, 11], "need": [0, 3, 4], "nest": 6, "new": [1, 3, 4, 6], "new_env": [0, 3, 4], "newsplitplan": [6, 8, 9], "none": [6, 8, 9], "normal": 6, "note": [0, 2, 9], "now": [2, 4], "nplanerevers": [6, 8, 9], "null": 9, "number": [1, 2, 6], "numer": 6, "numeric_format": [6, 8], "numericformat": [1, 6, 8, 9], "o": [0, 3], "object": 6, "onc": [0, 6], "one": [0, 6], "onli": [0, 6], "open": [0, 4, 6], "openmc": [0, 1, 6, 11], "openmc_pi": [6, 8, 9], "openmc_xml": [6, 8, 9, 10, 11], "opt": [0, 3, 4], "optim": 6, "option": [0, 1, 2, 3, 4, 6, 8, 9], "order": 6, "org": 0, "origin": [2, 6], "other": 6, "our": 0, "out": 6, "outformat": [6, 8, 9], "output": [0, 6], "output_filenam": [6, 10, 11], "overlap": 6, "own": 0, "p": 3, "p_abc": [6, 8, 9], "p_d": [6, 8, 9], "p_xyz": [6, 8, 9], "packag": [0, 1, 2, 7, 9, 11], "page": 0, "parallel": 6, "param": 6, "paramet": 6, "pass": [0, 8, 9, 10], "patch": 0, "path": [0, 6], "pdf": 5, "pep440": 2, "perform": [9, 11], "permiss": 0, "perpendicular": 6, "phit": [1, 6, 8, 9], "pick": 0, "pip": 0, "plane": 6, "pln_angl": [6, 8, 9], "pln_distanc": [6, 8, 9], "point": 6, "popul": 6, "posit": 6, "precis": 6, "prefix": 0, "present": 6, "press": 0, "print": 6, "prnt3pplane": [6, 8, 9], "process": [4, 6], "produc": 6, "prompt": 4, "provid": 2, "public": 5, "publish": 0, "pull": 1, "put": 0, "px": 6, "py": [0, 6, 8, 10], "pypi": 0, "pytest": 0, "python": [0, 1, 2, 3, 4, 7, 9, 11], "pz": 6, "quadric": 6, "quadricpi": [6, 8, 9], "quicker": [3, 4], "radii": 6, "radiu": 6, "rais": 6, "rang": 6, "read": 6, "readi": 0, "real": 6, "recip": 0, "recommend": [0, 1, 2], "refer": [1, 8, 9, 10, 11], "reflect": 2, "reinstal": 0, "rel": 6, "relativeprecis": [6, 8, 9], "relativetol": [6, 8, 9], "releas": [1, 2, 3], "reliabl": 0, "rememb": 10, "remot": 2, "replac": 0, "repo": [0, 3, 4], "repositori": [0, 2, 4], "repostori": 2, "request": [1, 6], "requir": 9, "rest": 6, "result": 6, "return": 6, "root": 0, "rst": 5, "run": [1, 2, 3, 4, 6, 8, 10], "s_r": [6, 8, 9], "s_xyz": [6, 8, 9], "same": [6, 8, 9], "scale": 6, "scaleup": [6, 8, 9], "script": [0, 2, 6, 8, 10], "sdef": 6, "section": [8, 9, 10, 11], "see": [6, 9, 11], "select": 2, "semant": [0, 2], "semiangl": 6, "separ": 6, "sequenc": 6, "serpent": [1, 6, 8, 9], "set": [0, 1, 6, 8, 9], "setup": 0, "setuptool": 2, "sever": [2, 5, 6], "sh": [0, 3], "shimwel": 0, "should": [0, 6, 11], "show": [8, 9, 10, 11], "simpli": [8, 10], "simplif": 6, "simplifi": [6, 8, 9], "singl": 6, "size": 6, "skip_solid": [6, 8, 9], "slice": 6, "so": [0, 2, 6], "solid": [1, 6, 8, 10], "sort_enclosur": [6, 8, 9], "sourc": [5, 6], "spaceclaim": 6, "specif": [9, 11], "specifi": [0, 6, 8, 9, 10, 11], "sph_distanc": [6, 8, 9], "sphinx": 0, "split": 6, "splitapi": 6, "splittoler": [6, 8, 9], "squash": 0, "ssh": 0, "stabl": 0, "standard": [0, 2], "start": [4, 6, 8], "startcel": [6, 8, 9], "startsurf": [6, 8, 9], "stem": 6, "step": [6, 8, 9, 10, 11], "stochast": [0, 6], "stop": 6, "stp": [8, 9], "str": 6, "straight": 0, "subdirectori": 0, "subsolid": 6, "success": 2, "suffix": 6, "suit": [8, 10], "support": [1, 11], "surfac": 6, "sx": 6, "sy": 6, "system": [2, 8, 10], "sz": 6, "t": 0, "t_r": [6, 8, 9], "t_xyz": [6, 8, 9], "tab": 0, "tabl": 6, "tag": [0, 2], "talli": 6, "tan": 6, "te": 11, "termin": [0, 3, 9, 11], "test": [1, 11], "test_convers": 0, "test_convert": 0, "text": 6, "than": [3, 4], "thew": 0, "thi": [0, 2, 6, 8, 9, 11], "threshold": 6, "time": 6, "titl": [6, 8, 9], "todo": [2, 5, 6], "toler": [1, 6, 8, 9], "tool": [0, 1, 3, 4, 7], "top": 6, "tor_angl": [6, 8, 9], "tor_dist": [6, 8, 9], "toru": 6, "training_on_geouned_tool": 5, "translat": [6, 9], "transport": 1, "tree": 6, "triangular": 6, "trigger": 0, "true": [6, 8, 9], "try": 0, "tupl": 6, "two": 6, "type": 6, "u": 3, "ucard": [6, 8, 9], "unam": [0, 3], "uncheck": 0, "unclos": 6, "under": 6, "unit": 6, "univers": 6, "universe_start": [6, 11], "up": [0, 6, 8], "updat": 0, "upstream": 2, "url": [0, 2], "us": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11], "usabl": 8, "usag": 1, "user": [0, 1, 2, 6, 8, 10], "user_guide_geouned_v2": 5, "usernam": 0, "util": 6, "v1": 0, "valu": [6, 8, 9], "valueerror": 6, "vaniti": 8, "variou": 5, "verbos": 0, "veri": 0, "version": [1, 2], "version_switch": 0, "view": 0, "visaibl": 0, "void": 6, "voidexclud": [6, 8, 9], "voidful": 6, "voidgen": [6, 8, 9], "voidmat": [6, 8, 9], "vol": 6, "volcard": [6, 8, 9], "volsdef": [6, 8, 9], "volum": [0, 6], "vv": 0, "wai": [6, 9], "want": 0, "we": [0, 3, 4, 8], "web": 0, "welcom": 0, "well": 2, "wget": 3, "when": [0, 2, 6, 9, 11], "where": [2, 6], "whether": 6, "which": [2, 4, 8, 9, 10], "whose": 6, "window": [1, 2], "within": [0, 3, 4], "without": [0, 6], "word": 6, "work": [9, 11], "would": 0, "write": 6, "written": 6, "x": 6, "x2": 6, "x86_64": [0, 3, 4], "xmax": 6, "xmin": 6, "xml": [10, 11], "xy": 6, "y": [0, 3, 4, 6], "y2": 6, "ymax": 6, "ymin": 6, "you": [0, 2, 3, 4, 8, 9, 10, 11], "your": [0, 2, 3, 4, 8, 9, 10, 11], "z": 6, "z2": 6, "zmax": 6, "zmin": 6}, "titles": ["Developer guide", "Geouned Documentation", "Install", "1. Linux", "2. Windows", "Methodology", "Python API reference", "Usage", "1. Python Package Usage, CAD to CSG conversion", "2. Command Line Tool Usage, CAD to CSG conversion", "3. Python Package Usage, CSG to CAD conversion", "4. Command Line Tool Usage, CSG to CAD conversion"], "titleterms": {"api": 6, "build": 0, "cad": [8, 9, 10, 11], "command": [9, 11], "conda": [0, 3, 4], "convers": [8, 9, 10, 11], "csg": [8, 9, 10, 11], "develop": 0, "doc": 0, "document": 1, "forg": 0, "geoun": 1, "guid": 0, "instal": [0, 2, 3, 4], "line": [9, 11], "linux": 3, "local": 0, "mamba": [0, 3, 4], "merg": 0, "methodologi": 5, "new": 0, "number": 0, "packag": [8, 10], "pull": 0, "python": [6, 8, 10], "recommend": [3, 4], "refer": 6, "releas": 0, "request": 0, "run": 0, "test": 0, "tool": [9, 11], "usag": [7, 8, 9, 10, 11], "user": [3, 4], "version": 0, "window": 4}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Building the docs locally": [[0, "building-the-docs-locally"]], "Command Line Tool Usage, CAD to CSG conversion": [[9, "command-line-tool-usage-cad-to-csg-conversion"]], "Command Line Tool Usage, CSG to CAD conversion": [[11, "command-line-tool-usage-csg-to-cad-conversion"]], "Conda Forge Releasing": [[0, "conda-forge-releasing"]], "Developer guide": [[0, "developer-guide"]], "Developer install with Mamba": [[0, "developer-install-with-mamba"]], "Geouned Documentation": [[1, "geouned-documentation"]], "Install": [[2, "install"]], "Linux": [[3, "linux"]], "Merging a pull requests": [[0, "merging-a-pull-requests"]], "Methodology": [[5, "methodology"]], "Python API reference": [[6, "python-api-reference"]], "Python Package Usage, CAD to CSG conversion": [[8, "python-package-usage-cad-to-csg-conversion"]], "Python Package Usage, CSG to CAD conversion": [[10, "python-package-usage-csg-to-cad-conversion"]], "Releasing a new version": [[0, "releasing-a-new-version"]], "Running the tests locally": [[0, "running-the-tests-locally"]], "Usage": [[7, "usage"]], "User install with Conda": [[3, "user-install-with-conda"], [4, "user-install-with-conda"]], "User install with Mamba (recommended)": [[3, "user-install-with-mamba-recommended"], [4, "user-install-with-mamba-recommended"]], "Version numbering": [[0, "version-numbering"]], "Windows": [[4, "windows"]]}, "docnames": ["developer_guide", "index", "install/index", "install/install_linux", "install/install_windows", "methodology", "python_api", "usage/index", "usage/python_cadtocsg_api_usage", "usage/python_cadtocsg_cli_usage", "usage/python_csgtocad_api_usage", "usage/python_csgtocad_cli_usage"], "envversion": {"sphinx": 61, "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": ["developer_guide.rst", "index.rst", "install/index.rst", "install/install_linux.rst", "install/install_windows.rst", "methodology.rst", "python_api.rst", "usage/index.rst", "usage/python_cadtocsg_api_usage.rst", "usage/python_cadtocsg_cli_usage.rst", "usage/python_csgtocad_api_usage.rst", "usage/python_csgtocad_cli_usage.rst"], "indexentries": {"cadtocsg (class in geouned)": [[6, "geouned.CadToCsg", false]], "csgtocad (class in geouned)": [[6, "geouned.CsgToCad", false]], "export_cad() (geouned.csgtocad method)": [[6, "geouned.CsgToCad.export_cad", false]], "export_csg() (geouned.cadtocsg method)": [[6, "geouned.CadToCsg.export_csg", false]], "from_json() (geouned.cadtocsg class method)": [[6, "geouned.CadToCsg.from_json", false]], "load_step_file() (geouned.cadtocsg method)": [[6, "geouned.CadToCsg.load_step_file", false]], "numericformat (class in geouned)": [[6, "geouned.NumericFormat", false]], "options (class in geouned)": [[6, "geouned.Options", false]], "settings (class in geouned)": [[6, "geouned.Settings", false]], "tolerances (class in geouned)": [[6, "geouned.Tolerances", false]]}, "objects": {"geouned": [[6, 0, 1, "", "CadToCsg"], [6, 0, 1, "", "CsgToCad"], [6, 0, 1, "", "NumericFormat"], [6, 0, 1, "", "Options"], [6, 0, 1, "", "Settings"], [6, 0, 1, "", "Tolerances"]], "geouned.CadToCsg": [[6, 1, 1, "", "export_csg"], [6, 1, 1, "", "from_json"], [6, 1, 1, "", "load_step_file"]], "geouned.CsgToCad": [[6, 1, 1, "", "export_cad"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"]}, "objtypes": {"0": "py:class", "1": "py:method"}, "terms": {"": [0, 6], "0": [0, 1, 5, 6, 8, 9, 10, 11], "000001": 8, "0001": [6, 8, 9], "01": [6, 8, 9], "06": [6, 9], "0e": 6, "1": [0, 1, 6, 8, 9], "10": 6, "100": 6, "1000": [6, 10, 11], "1001": 6, "11": [0, 3, 4, 6], "12": 6, "12f": [6, 8, 9], "13": [6, 8, 9], "14": [6, 8, 9], "15": 0, "15f": [6, 8, 9], "18": [6, 8, 9], "1e": [6, 9], "1m": 6, "1mm": 6, "2": [0, 6, 8, 9, 10], "200": [6, 8, 9], "3": [0, 3, 4, 6, 10], "30": [6, 8, 9], "4": [6, 10], "5": 6, "50": [6, 8, 9], "500": 10, "6": 6, "6e": [6, 8, 9], "7": 6, "7e": [6, 8, 9], "87": 6, "9": [0, 6], "A": [0, 6], "As": 0, "For": [0, 6, 8, 9, 11], "If": [0, 6, 8, 10], "In": 6, "It": [0, 3, 4, 6], "No": 6, "The": [0, 2, 6, 8, 9, 10, 11], "Then": [0, 3, 4, 9, 11], "There": [0, 2, 3, 4, 5, 8, 10], "These": 9, "To": 0, "_": 0, "_build": 0, "_description_": 6, "abl": [0, 3, 4], "accept": 6, "action": 0, "activ": [0, 3, 4], "ad": 0, "add": 0, "addit": [0, 6], "adjac": 6, "after": [0, 6], "air": 6, "algorithm": 6, "align": 6, "all": [0, 6, 11], "allow": 6, "along": 6, "also": [0, 2, 3, 4, 6, 8, 11], "altern": 6, "an": [0, 6, 11], "anaconda": [3, 4], "ancillari": 6, "angl": [6, 8, 9], "ani": 6, "apex": 6, "api": [1, 7, 8, 9, 10, 11], "approv": 0, "ar": [0, 2, 3, 4, 5, 6, 8, 10, 11], "area": 6, "argument": [6, 8, 9, 10, 11], "assign": 6, "associ": 6, "assum": [0, 8, 9, 11], "attribut": [6, 8, 9, 10, 11], "automat": [0, 6], "avail": [0, 4, 6], "awai": 0, "ax": 6, "axi": 6, "b": [0, 3, 6], "base": [0, 3, 6], "bash": [0, 3], "becaus": 0, "being": [6, 8, 9, 10, 11], "below": [0, 3, 4, 6, 8, 9, 10, 11], "between": [2, 6], "bin": 3, "bool": 6, "boolean": 6, "boptool": 6, "bot": 0, "both": [0, 11], "bound": 6, "boundari": 6, "bounding_box": [6, 10, 11], "box": [0, 6], "bracket": 6, "branch": 0, "browser": 0, "build": 1, "built": 0, "button": 0, "c": [0, 3, 4, 6], "c_r": [6, 8, 9], "c_xyz": [6, 8, 9], "cad": [1, 6, 7], "cad_from_csg": [6, 11], "cadtocsg": [1, 6, 8], "calcul": [0, 6], "call": [6, 8, 9, 11], "can": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11], "card": 6, "carlo": [1, 6], "carri": 6, "case": [0, 6, 8, 9, 10, 11], "cd": 0, "cell": 6, "cell_rang": [6, 10, 11], "cell_range_typ": [6, 10, 11], "cellcommentfil": [6, 8, 9], "cellsummaryfil": [6, 8, 9], "center": 6, "central": 2, "challeng": 2, "chang": [0, 6, 8, 10], "channel": 0, "check": [0, 6], "checkout": 0, "ci": 0, "class": [6, 8, 9, 10, 11], "classmethod": 6, "cli": 7, "click": 0, "clone": 0, "close": [9, 11], "cm": 6, "cmd": 2, "code": [0, 1, 6], "coeffici": 6, "com": [0, 3, 4], "command": [0, 1, 3, 4, 7, 8], "comment": 6, "commit": 0, "comparison": 6, "complementari": 6, "complet": [2, 4, 8, 9, 11], "complic": 2, "compound": 6, "compsolid": [6, 8, 9], "conda": [1, 2], "cone": 6, "config": [6, 8, 9, 11], "config_mcnp": 11, "config_openmc": 11, "configur": [8, 9, 11], "conform": 2, "connect": 2, "consid": 6, "constraint": 6, "construct": [1, 8, 10], "contain": [6, 9, 11], "content": [9, 11], "convers": [1, 6, 7], "convert": [1, 5, 6, 8, 9, 10, 11], "converted_with_geoun": 6, "coordin": 6, "copi": 0, "correct": 0, "could": 0, "creat": [0, 3, 4, 6, 9, 11], "csg": [1, 6, 7], "csg_file": 11, "csg_format": [6, 10, 11], "csgtocad": [1, 6, 10], "cuboid": [8, 9], "curl": [0, 3], "current": [0, 2, 3, 6, 9, 11], "cut": 6, "cyl_angl": [6, 8, 9], "cyl_dist": [6, 8, 9], "cylind": 6, "cylinder_box": [10, 11], "d": 6, "data": 5, "data_class": 6, "debug": [6, 8, 9], "decompos": 6, "decomposit": 6, "default": [0, 6, 8, 9, 10, 11], "defin": 6, "definit": 6, "delet": 6, "dellastnumb": [6, 8, 9], "depend": [0, 2], "describ": 10, "descript": [0, 9, 11], "desir": [6, 8, 10], "determin": 6, "dev": 0, "dev1": 1, "develop": 1, "directori": [0, 8, 9, 11], "distanc": [6, 8, 9], "distribut": [0, 3, 4], "doc": [1, 5], "document": [5, 8, 9, 10, 11], "don": 0, "done": [0, 6], "download": [0, 3, 4], "dummi": 6, "dummymat": [6, 8, 9], "dure": 6, "e": [0, 2], "each": [6, 9, 11], "edg": 6, "edit": 0, "effect": 6, "enclosur": 6, "encompass": 6, "enlarg": 6, "enlargebox": [6, 8, 9], "ensur": 0, "entir": 6, "entri": 0, "environ": [0, 3, 4], "equal": 6, "evalu": 6, "everi": [8, 9, 10, 11], "ex": 4, "exactli": 6, "exampl": [0, 6, 8, 9, 10, 11], "exclud": [6, 10], "execut": [4, 6, 9, 11], "export": 6, "export_cad": [1, 6, 10, 11], "export_csg": [1, 6, 8, 9], "export_to_csg": 6, "exportsolid": [6, 8, 9], "extract": 6, "face": 6, "facet": [6, 8, 9], "fals": [6, 8, 9], "faster": [0, 6], "fcstd": 6, "featur": 0, "feedstock": 0, "fetch": 2, "few": [0, 3, 4, 10], "file": [0, 6, 8, 9, 10, 11], "filenam": [6, 8, 9], "filenotfounderror": 6, "first": [0, 3, 4, 6, 9, 11], "float": 6, "follow": [0, 3, 4, 8, 9, 10, 11], "forc": 6, "forcecylind": [6, 8, 9], "forcenooverlap": [6, 8, 9], "forg": [1, 3, 4], "fork": [0, 2], "form": [0, 6], "format": [1, 5, 6, 8, 11], "former": 6, "found": 6, "freecad": [0, 2, 6, 8, 10], "from": [0, 3, 4, 6, 8], "from_json": [1, 6, 8], "frrecad": 2, "full": [6, 9, 11], "fuller": [3, 4], "function": [0, 6], "fuzzi": 6, "g": 0, "ge242565": 1, "gener": [0, 6], "geo": [8, 10], "geometri": [1, 6, 8, 10], "geometrynam": [6, 8, 9], "geoun": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "geouned_cadtocsg": [0, 3, 4, 9], "geouned_csgtocad": 11, "get": [0, 2, 4, 6, 9], "gh": 0, "git": [0, 2], "github": [0, 3, 4], "go": 0, "gq": 6, "gq_10": [6, 8, 9], "gq_1to6": [6, 8, 9], "gq_7to9": [6, 8, 9], "group": 6, "guid": 1, "ha": [0, 2, 6], "had": 2, "happen": 6, "have": [0, 2, 6, 8, 9, 10, 11], "help": [0, 3, 4], "here": [0, 3, 4, 9, 11], "highest": 6, "how": [2, 6], "howev": [0, 2], "html": 0, "http": [0, 3, 4], "i": [0, 2, 3, 4, 6, 8, 9, 10, 11], "id": 6, "implic": 2, "import": [0, 3, 4, 8, 10], "inbuilt": 2, "includ": [0, 1, 3, 4, 6], "independ": 6, "index": [0, 6], "individu": 0, "inform": 6, "init": 3, "input": 6, "input_filenam": [6, 10, 11], "insid": 6, "instal": [1, 8, 10], "instanc": 6, "instead": [0, 6], "instruct": [0, 3, 4], "int": 6, "integr": 2, "interfac": [8, 9, 11], "interpret": 0, "invalid": 6, "involv": 6, "io": 0, "issu": 6, "its": 6, "join": 6, "json": [0, 6, 8, 9, 11], "k": 0, "k_tan2": [6, 8, 9], "k_xyz": [6, 8, 9], "kei": [0, 6], "keyword": [9, 11], "kne_angl": [6, 8, 9], "kne_dist": [6, 8, 9], "l": [0, 3], "label": 6, "last": 6, "latest": [0, 3, 4], "least": 0, "left": 6, "level": 6, "level_max": [6, 11], "librari": 2, "like": 0, "line": [0, 1, 3, 4, 7, 8], "link": [0, 4], "linux": [0, 1, 2], "list": [2, 6], "load": [6, 8], "load_step_fil": [1, 6, 8, 9], "local": 1, "locat": 6, "logic": 6, "look": [0, 6], "m": [0, 3], "made": 0, "mai": 6, "main": [0, 2, 8, 10], "major": [0, 6], "make": [0, 2, 8, 10], "mamba": [1, 2], "mani": 8, "manner": 2, "mat_dens": 6, "mat_descript": 6, "mat_label": 6, "mat_rang": [6, 11], "mat_range_typ": [6, 11], "match": [6, 9, 11], "materi": 6, "matfil": [6, 8, 9], "maxbracket": [6, 8, 9], "maximum": 6, "maxsurf": [6, 8, 9], "mcnp": [1, 6, 8, 9, 11], "menu": 4, "merg": 1, "method": [2, 6, 9, 10, 11], "methodologi": 1, "might": 0, "millimet": 6, "min_area": [6, 8, 9], "miniconda": [3, 4], "miniconda3": [3, 4], "miniforg": [0, 3, 4], "miniforge3": [0, 3, 4], "minim": [8, 9, 10, 11], "minimum": 6, "minor": [0, 6], "minvoids": [6, 8, 9], "mkdir": 3, "mm": 6, "model": 6, "modul": 6, "mont": [1, 6], "more": [0, 2, 6, 8], "most": [6, 8, 9, 10, 11], "multipl": 6, "multipli": 6, "must": 2, "mx": 6, "my_new_featur": 0, "my_numeric_format": 8, "my_opt": 8, "my_set": 8, "my_toler": 8, "name": [0, 3, 4, 6, 11], "need": [0, 3, 4], "nest": 6, "new": [1, 3, 4, 6], "new_env": [0, 3, 4], "newsplitplan": [6, 8, 9], "none": [6, 8, 9], "normal": 6, "note": [0, 2, 9], "now": [2, 4], "nplanerevers": [6, 8, 9], "null": 9, "number": [1, 2, 6], "numer": 6, "numeric_format": [6, 8], "numericformat": [1, 6, 8, 9], "o": [0, 3], "object": 6, "onc": [0, 6], "one": [0, 6], "onli": [0, 6], "open": [0, 4, 6], "openmc": [0, 1, 6, 11], "openmc_pi": [6, 8, 9], "openmc_xml": [6, 8, 9, 10, 11], "opt": [0, 3, 4], "optim": 6, "option": [0, 1, 2, 3, 4, 6, 8, 9], "order": 6, "org": 0, "origin": [2, 6], "other": 6, "our": 0, "out": 6, "outformat": [6, 8, 9], "output": [0, 6], "output_filenam": [6, 10, 11], "overlap": 6, "own": 0, "p": 3, "p_abc": [6, 8, 9], "p_d": [6, 8, 9], "p_xyz": [6, 8, 9], "packag": [0, 1, 2, 7, 9, 11], "page": 0, "parallel": 6, "param": 6, "paramet": 6, "pass": [0, 8, 9, 10], "patch": 0, "path": [0, 6], "pdf": 5, "pep440": 2, "perform": [9, 11], "permiss": 0, "perpendicular": 6, "phit": [1, 6, 8, 9], "pick": 0, "pip": 0, "plane": 6, "pln_angl": [6, 8, 9], "pln_distanc": [6, 8, 9], "point": 6, "popul": 6, "posit": 6, "precis": 6, "prefix": 0, "present": 6, "press": 0, "print": 6, "prnt3pplane": [6, 8, 9], "process": [4, 6], "produc": 6, "prompt": 4, "provid": 2, "public": 5, "publish": 0, "pull": 1, "put": 0, "px": 6, "py": [0, 6, 8, 10], "pypi": 0, "pytest": 0, "python": [0, 1, 2, 3, 4, 7, 9, 11], "pz": 6, "quadric": 6, "quadricpi": [6, 8, 9], "quicker": [3, 4], "radii": 6, "radiu": 6, "rais": 6, "rang": 6, "read": 6, "real": 6, "recip": 0, "recommend": [0, 1, 2], "refer": [1, 8, 9, 10, 11], "reflect": 2, "reinstal": 0, "rel": 6, "relativeprecis": [6, 8, 9], "relativetol": [6, 8, 9], "releas": [1, 2, 3], "reliabl": 0, "rememb": 10, "remot": 2, "replac": 0, "repo": [0, 3, 4], "repositori": [0, 2, 4], "repostori": 2, "request": [1, 6], "requir": 9, "rest": 6, "result": 6, "return": 6, "root": 0, "rst": 5, "run": [1, 2, 3, 4, 6, 8, 10], "s_r": [6, 8, 9], "s_xyz": [6, 8, 9], "same": [6, 8, 9], "scale": 6, "scaleup": [6, 8, 9], "script": [0, 2, 6, 8, 10], "sdef": 6, "section": [8, 9, 10, 11], "see": [6, 9, 11], "select": 2, "semant": [0, 2], "semiangl": 6, "separ": 6, "sequenc": 6, "serpent": [1, 6, 8, 9], "set": [0, 1, 6, 8, 9], "setup": 0, "setuptool": 2, "sever": [2, 5, 6], "sh": [0, 3], "shimwel": 0, "short": 0, "should": [0, 6, 11], "show": [8, 9, 10, 11], "simpli": [8, 10], "simplif": 6, "simplifi": [6, 8, 9], "singl": 6, "size": 6, "skip_solid": [6, 8, 9], "slice": 6, "so": [0, 2, 6], "solid": [1, 6, 8, 10], "sort_enclosur": [6, 8, 9], "sourc": [5, 6], "spaceclaim": 6, "specif": [9, 11], "specifi": [0, 6, 8, 9, 10, 11], "sph_distanc": [6, 8, 9], "sphinx": 0, "split": 6, "splitapi": 6, "splittoler": [6, 8, 9], "squash": 0, "ssh": 0, "stabl": 0, "standard": [0, 2], "start": [4, 6, 8], "startcel": [6, 8, 9], "startsurf": [6, 8, 9], "stem": 6, "step": [6, 8, 9, 10, 11], "stochast": [0, 6], "stop": 6, "stp": [8, 9], "str": 6, "straight": 0, "subdirectori": 0, "subsolid": 6, "success": 2, "suffix": 6, "suit": [8, 10], "support": [1, 11], "surfac": 6, "sx": 6, "sy": 6, "system": [2, 8, 10], "sz": 6, "t": 0, "t_r": [6, 8, 9], "t_xyz": [6, 8, 9], "tab": 0, "tabl": 6, "tag": [0, 2], "talli": 6, "tan": 6, "te": 11, "termin": [0, 3, 9, 11], "test": [1, 11], "test_convers": 0, "test_convert": 0, "text": 6, "than": [3, 4], "thi": [0, 2, 6, 8, 9, 11], "threshold": 6, "time": 6, "titl": [6, 8, 9], "todo": [2, 5, 6], "toler": [1, 6, 8, 9], "tool": [0, 1, 3, 4, 7], "top": 6, "tor_angl": [6, 8, 9], "tor_dist": [6, 8, 9], "toru": 6, "training_on_geouned_tool": 5, "translat": [6, 9], "transport": 1, "tree": 6, "triangular": 6, "trigger": 0, "true": [6, 8, 9], "try": 0, "tupl": 6, "two": 6, "type": 6, "u": 3, "ucard": [6, 8, 9], "unam": [0, 3], "uncheck": 0, "unclos": 6, "under": 6, "unit": 6, "univers": 6, "universe_start": [6, 11], "up": [0, 6, 8], "updat": 0, "upstream": 2, "url": [0, 2], "us": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11], "usabl": 8, "usag": 1, "user": [0, 1, 2, 6, 8, 10], "user_guide_geouned_v2": 5, "usernam": 0, "util": 6, "v1": 0, "valu": [6, 8, 9], "valueerror": 6, "vaniti": 8, "variou": 5, "verbos": 0, "veri": 0, "version": [1, 2], "version_switch": 0, "view": 0, "visibl": 0, "void": 6, "voidexclud": [6, 8, 9], "voidful": 6, "voidgen": [6, 8, 9], "voidmat": [6, 8, 9], "vol": 6, "volcard": [6, 8, 9], "volsdef": [6, 8, 9], "volum": [0, 6], "vv": 0, "wai": [6, 9], "we": [0, 3, 4, 8], "web": 0, "welcom": 0, "well": 2, "wget": 3, "when": [0, 2, 6, 9, 11], "where": [2, 6], "whether": 6, "which": [2, 4, 8, 9, 10], "while": 0, "whose": 6, "window": [1, 2], "within": [0, 3, 4], "without": [0, 6], "word": 6, "work": [9, 11], "would": 0, "write": 6, "written": 6, "x": 6, "x2": 6, "x86_64": [0, 3, 4], "xmax": 6, "xmin": 6, "xml": [10, 11], "xy": 6, "y": [0, 3, 4, 6], "y2": 6, "ymax": 6, "ymin": 6, "you": [0, 2, 3, 4, 8, 9, 10, 11], "your": [0, 2, 3, 4, 8, 9, 10, 11], "z": 6, "z2": 6, "zmax": 6, "zmin": 6}, "titles": ["Developer guide", "Geouned Documentation", "Install", "1. Linux", "2. Windows", "Methodology", "Python API reference", "Usage", "1. Python Package Usage, CAD to CSG conversion", "2. Command Line Tool Usage, CAD to CSG conversion", "3. Python Package Usage, CSG to CAD conversion", "4. Command Line Tool Usage, CSG to CAD conversion"], "titleterms": {"api": 6, "build": 0, "cad": [8, 9, 10, 11], "command": [9, 11], "conda": [0, 3, 4], "convers": [8, 9, 10, 11], "csg": [8, 9, 10, 11], "develop": 0, "doc": 0, "document": 1, "forg": 0, "geoun": 1, "guid": 0, "instal": [0, 2, 3, 4], "line": [9, 11], "linux": 3, "local": 0, "mamba": [0, 3, 4], "merg": 0, "methodologi": 5, "new": 0, "number": 0, "packag": [8, 10], "pull": 0, "python": [6, 8, 10], "recommend": [3, 4], "refer": 6, "releas": 0, "request": 0, "run": 0, "test": 0, "tool": [9, 11], "usag": [7, 8, 9, 10, 11], "user": [3, 4], "version": 0, "window": 4}}) \ No newline at end of file diff --git a/dev/usage/index.html b/dev/usage/index.html index bbbb2517..63998324 100644 --- a/dev/usage/index.html +++ b/dev/usage/index.html @@ -8,7 +8,7 @@ - Usage — GEOUNED 0.1.dev1+gf7f4279 documentation + Usage — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/usage/python_cadtocsg_api_usage.html b/dev/usage/python_cadtocsg_api_usage.html index ee04e842..c6983390 100644 --- a/dev/usage/python_cadtocsg_api_usage.html +++ b/dev/usage/python_cadtocsg_api_usage.html @@ -8,7 +8,7 @@ - 1. Python Package Usage, CAD to CSG conversion — GEOUNED 0.1.dev1+gf7f4279 documentation + 1. Python Package Usage, CAD to CSG conversion — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/usage/python_cadtocsg_cli_usage.html b/dev/usage/python_cadtocsg_cli_usage.html index 9df2ab33..4e09299b 100644 --- a/dev/usage/python_cadtocsg_cli_usage.html +++ b/dev/usage/python_cadtocsg_cli_usage.html @@ -8,7 +8,7 @@ - 2. Command Line Tool Usage, CAD to CSG conversion — GEOUNED 0.1.dev1+gf7f4279 documentation + 2. Command Line Tool Usage, CAD to CSG conversion — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/usage/python_csgtocad_api_usage.html b/dev/usage/python_csgtocad_api_usage.html index 108f90e4..31c4a140 100644 --- a/dev/usage/python_csgtocad_api_usage.html +++ b/dev/usage/python_csgtocad_api_usage.html @@ -8,7 +8,7 @@ - 3. Python Package Usage, CSG to CAD conversion — GEOUNED 0.1.dev1+gf7f4279 documentation + 3. Python Package Usage, CSG to CAD conversion — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - + diff --git a/dev/usage/python_csgtocad_cli_usage.html b/dev/usage/python_csgtocad_cli_usage.html index a844e912..271c4aa3 100644 --- a/dev/usage/python_csgtocad_cli_usage.html +++ b/dev/usage/python_csgtocad_cli_usage.html @@ -8,7 +8,7 @@ - 4. Command Line Tool Usage, CSG to CAD conversion — GEOUNED 0.1.dev1+gf7f4279 documentation + 4. Command Line Tool Usage, CSG to CAD conversion — GEOUNED 0.1.dev1+ge242565 documentation @@ -35,7 +35,7 @@ - +