searchindex.js

Search.setIndex({"docnames": ["developer/codeconventions", "developer/developer", "developer/documentation", "index", "installation/configuration", "installation/dependencies", "installation/installation"], "filenames": ["developer/codeconventions.rst", "developer/developer.rst", "developer/documentation.rst", "index.rst", "installation/configuration.rst", "installation/dependencies.rst", "installation/installation.rst"], "titles": ["Code Conventions", "Development instructions", "Documentation", "PartExa - A Particle Library for the Exa-Scale", "Configuration and installation", "Dependencies", "Installation instructions"], "terms": {"thi": [0, 1, 2, 6], "page": [0, 1, 6], "provid": [0, 1, 2, 3, 4, 5, 6], "gener": [0, 1, 2, 3], "ar": [0, 2, 3, 4, 5], "follow": [0, 1, 4, 5], "partexa": [0, 2, 5, 6], "The": [0, 2, 3, 4, 5], "file": [0, 5], "repositori": [0, 4, 5], "shall": 0, "compliant": 0, "standard": [0, 5], "look": 0, "e": 0, "g": 0, "cmake": [0, 4, 5], "A": 0, "particl": 0, "librari": [0, 5, 6], "exa": 0, "scale": 0, "copyright": 0, "c": [0, 3, 5], "2021": 0, "author": 0, "program": [0, 3], "free": 0, "softwar": [0, 2], "you": 0, "can": [0, 4, 5], "redistribut": 0, "modifi": 0, "under": 0, "term": 0, "gnu": 0, "public": 0, "publish": 0, "foundat": 0, "either": 0, "version": [0, 2, 5], "3": [0, 5], "your": 0, "option": 0, "ani": [0, 4], "later": [0, 5], "distribut": [0, 3, 5], "hope": 0, "us": [0, 2, 3, 4, 5], "without": 0, "warranti": 0, "even": 0, "impli": 0, "merchant": 0, "fit": 0, "FOR": 0, "particular": 0, "purpos": 0, "see": 0, "more": [0, 5], "detail": [0, 6], "should": [0, 1], "have": 0, "receiv": 0, "copi": 0, "along": [0, 3, 5, 6], "If": 0, "http": [0, 5], "www": 0, "org": [0, 5], "year": 0, "s": 0, "within": [0, 2], "statement": 0, "set": [0, 4], "ad": 0, "repo": 0, "time": [0, 4], "span": 0, "creat": 0, "last": 0, "2025": 0, "For": [0, 2, 4, 5], "conveni": [0, 4], "script": 0, "check": 0, "all": [0, 4, 5], "respect": 0, "chang": [0, 4], "latest": [0, 5], "master": 0, "To": [0, 4], "current": 0, "out": 0, "commit": 0, "execut": [0, 4], "cd": [0, 4, 5], "partexa_sourc": [0, 4], "util": 0, "run": 0, "head": 0, "sh": [0, 5], "branch": 0, "final": 0, "index": 0, "prior": 0, "which": [1, 5], "consist": 1, "document": [1, 3, 6], "sphinx": [1, 6], "doxygen": [1, 6], "code": [1, 2, 3, 4, 5], "convent": [1, 3], "licens": 1, "header": 1, "write": 2, "reliabl": 2, "project": 2, "an": [2, 3, 5], "essenti": 2, "part": 2, "develop": [2, 5], "In": [2, 4], "context": 2, "import": 2, "aspect": [2, 3], "amongst": 2, "other": [2, 3], "get": 2, "start": 2, "guid": 2, "instal": [2, 5], "instruct": [2, 3, 5], "give": 2, "overview": [2, 5], "implement": 2, "feautur": 2, "cover": 2, "sourc": [2, 3, 4, 5], "henc": 2, "proper": 2, "improv": 2, "qualiti": 2, "facilit": [2, 3], "maintabl": 2, "ensur": 2, "transfer": 2, "knowledg": 2, "user": 2, "reason": 2, "mandatori": 2, "keep": 2, "up": [2, 4], "date": 2, "twofold": 2, "base": [2, 3, 5], "recent": [2, 4, 5], "precomil": 2, "onlin": [2, 4], "todo": 2, "open": 3, "written": 3, "state": [3, 5], "art": 3, "techniqu": 3, "strongli": [3, 5], "depend": [3, 4, 6], "finit": [3, 5], "element": [3, 5], "deal": [3, 6], "ii": [3, 6], "p4est": [3, 6], "parallel": [3, 5], "adapt": [3, 5], "quadtre": [3, 5], "octre": [3, 5], "basic": 3, "function": 3, "strong": 3, "focu": 3, "effici": 3, "data": 3, "structur": 3, "major": 3, "featur": 3, "includ": [3, 5], "neighbor": 3, "search": 3, "algorithm": 3, "cell": 3, "face": 3, "vertex": 3, "pair": 3, "multipl": 3, "phase": 3, "transit": 3, "between": 3, "cluster": 3, "connect": 3, "rigid": 3, "bond": 3, "evalu": 3, "routin": 3, "varieti": 3, "method": 3, "discret": 3, "dem": 3, "smooth": 3, "hydrodynam": 3, "sph": 3, "peridynam": 3, "pd": 3, "make": [3, 4, 5], "sophist": 3, "interfac": 3, "coupl": 3, "configur": [3, 5, 6], "associ": [4, 6], "first": 4, "clone": [4, 5], "git": [4, 5], "github": [4, 5], "com": [4, 5], "assum": [4, 5], "met": 4, "build": [4, 6], "mkdir": [4, 5], "partexa_build": 4, "dcmake_build_typ": 4, "build_typ": 4, "ddeal_ii_dir": 4, "dealii_instal": [4, 5], "j": [4, 5], "np": 4, "where": [4, 5], "denot": 4, "type": 4, "releas": [4, 5], "debug": 4, "specif": 4, "number": 4, "processor": 4, "compil": [4, 5], "manual": 4, "virtual": 4, "python": 4, "environ": [4, 5], "python3": 4, "m": 4, "venv": 4, "bin": 4, "activ": 4, "pip": 4, "sphinx_rtd_them": 4, "next": 4, "step": [4, 5], "reconfigur": 4, "precompil": 4, "packag": 4, "graphviz": 4, "third": 5, "parti": 5, "need": 5, "It": 5, "mpi": 5, "present": 5, "explicit": 5, "12": 5, "0": 5, "below": 5, "given": 5, "here": 5, "dealii": 5, "readm": 5, "html": 5, "extern": 5, "lib": 5, "dealii_sourc": 5, "download": 5, "tarbal": 5, "p4est_sourc": 5, "wget": 5, "io": 5, "x": 5, "y": 5, "z": 5, "tar": 5, "gz": 5, "name": 5, "stabl": 5, "found": 5, "scipt": 5, "p4est_instal": 5, "doc": 5, "setup": 5, "dealii_build": 5, "dcmake_install_prefix": 5, "dp4est_dir": 5, "ddeal_ii_with_p4est": 5, "ON": 5, "ddeal_ii_with_mpi": 5, "num_proc": 5, "descript": 6, "how": 6, "its": 6, "well": 6, "system": 6, "requir": 6}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"code": 0, "convent": 0, "licens": 0, "header": 0, "develop": [1, 3], "instruct": [1, 6], "document": [2, 4], "sphinx": [2, 4], "doxygen": [2, 4], "partexa": [3, 4], "A": 3, "particl": 3, "librari": [3, 4], "exa": 3, "scale": 3, "instal": [3, 4, 6], "guid": 3, "configur": 4, "depend": 5, "system": 5, "requir": 5, "deal": 5, "ii": 5, "p4est": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})