{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# OGS Container Maker\n\n## General usage\n\n### Installation\n\n```bash\nvirtualenv ~/.venv/ogs-container-maker\nsource ~/.venv/ogs-container-maker/bin/activate\npip install ogscm\n```\n\n### Generate container definition\n\n```bash\n$ ogscm\nCreating 1 image definition(s)...\nCreated definition _out/docker/ubuntu_17.10/ogs-4c7de6a4/serial/conan/cmake-d41d8cd9/Dockerfile \n\n# With user options\n$ ogscm --format singularity --ompi 2.1.3 --cmake_args ' -DOGS_BUILD_PROCESSES=GroundwaterFlow'\nCreating 1 image definition(s)...\nCreated definition _out/singularity/ubuntu_17.10/ogs-4c7de6a4/openmpi-2.1.3/conan/cmake-fde09bf7/Singularity.de\n```\n\n### Build image\n\nAdd the `--build`-flag.\n\nConvert Docker image to Singularity image:\n\nAdd the `--convert`-flag (requires Singularity 3.x).\n\n### Run\n\n```bash\ndocker run --it --rm ogs-ompi-2.1.3\n# in container:\nogs --version\n```\n\n```bash\nsingularity shell ogs-ompi-2.1.3.sif\n# in container:\nogs --version\n# OR directly run from host\nsingularity exec ogs-ompi-2.1.3.sif ogs local/path/to/square_1e0.prj\n```\n\n## Using the combinatorial builder\n\nCreates Docker definition files with different OpenMPI implementations and OpenGeoSys parallel configuration (from the current master), builds the docker images and converts them to Singularity images: \n\n```bash\npython build.py --ogs ufz/ogs@master --ompi 2.1.2 3.1.2 --build --convert\n```\n\nCheck help for more options:\n\n```bash\n$ ogscm --help\nusage: ogscm [-h] [--recipe RECIPE] [--out OUT] [--file FILE] [--print]\n [--format [{docker,singularity} [{docker,singularity} ...]]]\n [--pm [{system,conan} [{system,conan} ...]]]\n [--ompi [OMPI [OMPI ...]]] [--ogs [OGS [OGS ...]]]\n [--cmake_args [CMAKE_ARGS [CMAKE_ARGS ...]]] [--build] [--upload]\n [--registry REGISTRY] [--convert] [--runtime-only]\n [--base_image BASE_IMAGE] [--clang] [--gui] [--docs] [--jenkins]\n [--cvode] [--cppcheck] [--iwyy] [--gcovr] [--dev]\n [--compiler_version COMPILER_VERSION]\n\nGenerate container image definitions.\n\noptional arguments:\n -h, --help show this help message and exit\n --recipe RECIPE HPCCM recipe (default: recipes/ogs-builder.py)\n --out OUT Output directory (default: _out)\n --file FILE Overwrite output recipe file name (default: )\n --print, -P Print the definition to stdout (default: False)\n\nCombinatorial options:\n All combinations of the given options will be generated\n\n --format [{docker,singularity} [{docker,singularity} ...]]\n --pm [{system,conan} [{system,conan} ...]]\n Package manager to install third-party dependencies\n (default: ['conan'])\n --ompi [OMPI [OMPI ...]]\n OpenMPI version, e.g. 2.1.1, 2.1.5, 3.0.1, 3.1.2\n (default: ['off'])\n --ogs [OGS [OGS ...]]\n OGS GitHub repo in the form 'user/repo@branch' or\n 'off' to disable OGS building (default:\n ['ufz/ogs@master'])\n --cmake_args [CMAKE_ARGS [CMAKE_ARGS ...]]\n CMake argument sets have to be quoted and **must**\n start with a space. e.g. --cmake_args ' -DFIRST=TRUE\n -DFOO=BAR' ' -DSECOND=TRUE' (default: [''])\n\nImage build options:\n --build, -B Build the images from the definition files (default:\n False)\n --upload, -U Upload Docker image to registry (default: False)\n --registry REGISTRY The docker registry the image is tagged and uploaded\n to. (default: registry.opengeosys.org/ogs/ogs)\n --convert, -C Convert Docker image to Singularity image (default:\n False)\n --runtime-only, -R Generate multi-stage Dockerfiles for small runtime\n images (default: False)\n\nAdditional options:\n --base_image BASE_IMAGE\n The base image. 'centos:7' is supported too. (default:\n ubuntu:17.10)\n --clang Use clang instead of gcc (default: False)\n --gui Builds the GUI (Data Explorer) (default: False)\n --docs Setup documentation requirements (Doxygen) (default:\n False)\n --jenkins Setup Jenkins slave (default: False)\n --cvode Install and configure with cvode (default: False)\n --cppcheck Install cppcheck (default: False)\n --iwyy Install include-what-you-use (default: False)\n --gcovr Install gcovr (default: False)\n --dev Installs development tools (vim, gdb) (default: False)\n --compiler_version COMPILER_VERSION\n Compiler version. (default: )\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ufz/ogs-container-maker", "keywords": "", "license": "BSD 3-Clause", "maintainer": "Lars Bilke", "maintainer_email": "lars.bilke@ufz.de", "name": "ogscm", "package_url": "https://pypi.org/project/ogscm/", "platform": "", "project_url": "https://pypi.org/project/ogscm/", "project_urls": { "Homepage": "https://github.com/ufz/ogs-container-maker" }, "release_url": "https://pypi.org/project/ogscm/1.2.0/", "requires_dist": [ "enum34", "six", "requests", "hpccm" ], "requires_python": "", "summary": "OGS Container Maker", "version": "1.2.0" }, "last_serial": 5003329, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "b1e77d91fc402152c3e543c3f7d6004a", "sha256": "3c21b626dc405084d0525aa63a80731196515e839319100df94837cba119f9e6" }, "downloads": -1, "filename": "ogscm-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "b1e77d91fc402152c3e543c3f7d6004a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31076, "upload_time": "2019-03-28T14:53:31", "url": "https://files.pythonhosted.org/packages/3d/7e/eb3c0a76683a3223f19c1e43863f9499bf88a618c5a6dde3b24f4d98d736/ogscm-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "08081af040404ec4f2748decdc95e517", "sha256": "3c00a51de2c131f30126adca8d75d23492ff6c9aa94f6f93e807744609ecfe2e" }, "downloads": -1, "filename": "ogscm-0.0.2.tar.gz", "has_sig": false, "md5_digest": "08081af040404ec4f2748decdc95e517", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16905, "upload_time": "2019-03-28T14:53:35", "url": "https://files.pythonhosted.org/packages/f0/22/e3127d2e93d118741ff0096e204c02a348d5b08deccf4cbfa35e851bdd52/ogscm-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "82f4911001bcfe5d8a52ce1e5c6654f1", "sha256": "1f440af7a9eff96d40b1eac0c7fe1af952bcafac42e61ac337934e3e51463f4c" }, "downloads": -1, "filename": "ogscm-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "82f4911001bcfe5d8a52ce1e5c6654f1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31068, "upload_time": "2019-03-28T14:53:33", "url": "https://files.pythonhosted.org/packages/cd/a1/738314dcfc15569aaf07d9df49d6c3634d39f40f3ccf784c9f37a03276ba/ogscm-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a6dd9e3671b03e1c6d092757a9deda24", "sha256": "3f5ed8759fa5a3c0defbf26f0c1384375d6ee045d44b68a4973b66c1186b354a" }, "downloads": -1, "filename": "ogscm-0.0.3.tar.gz", "has_sig": false, "md5_digest": "a6dd9e3671b03e1c6d092757a9deda24", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16907, "upload_time": "2019-03-28T14:53:36", "url": "https://files.pythonhosted.org/packages/d9/cf/9753654912c794d34e91ac7055604257f5ae130b3a3da9917683a0a55a43/ogscm-0.0.3.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "4101307b5ae5861873bbc6d0a9e9a860", "sha256": "d003ecb087633beb12a5bc7685a0b5c897c12fff45fe65f954093b961e82312f" }, "downloads": -1, "filename": "ogscm-1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4101307b5ae5861873bbc6d0a9e9a860", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31454, "upload_time": "2019-03-29T13:41:46", "url": "https://files.pythonhosted.org/packages/50/06/8f1dce7f64cd578262dbb700e460aee8098d2b90338d520ad6576d687254/ogscm-1.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cc47bd92a90e0425c6b311e1de931a1d", "sha256": "7fb60ea5c22c6783365bd6c51931630d667e6b11010f41d088c7aa5f4df01640" }, "downloads": -1, "filename": "ogscm-1.2.0.tar.gz", "has_sig": false, "md5_digest": "cc47bd92a90e0425c6b311e1de931a1d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17507, "upload_time": "2019-03-29T13:41:49", "url": "https://files.pythonhosted.org/packages/de/0b/276a1a82fab391a64ab976ddc4f9ab6e2504e6bcd2bfd4e58fa85ea55964/ogscm-1.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4101307b5ae5861873bbc6d0a9e9a860", "sha256": "d003ecb087633beb12a5bc7685a0b5c897c12fff45fe65f954093b961e82312f" }, "downloads": -1, "filename": "ogscm-1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4101307b5ae5861873bbc6d0a9e9a860", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31454, "upload_time": "2019-03-29T13:41:46", "url": "https://files.pythonhosted.org/packages/50/06/8f1dce7f64cd578262dbb700e460aee8098d2b90338d520ad6576d687254/ogscm-1.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cc47bd92a90e0425c6b311e1de931a1d", "sha256": "7fb60ea5c22c6783365bd6c51931630d667e6b11010f41d088c7aa5f4df01640" }, "downloads": -1, "filename": "ogscm-1.2.0.tar.gz", "has_sig": false, "md5_digest": "cc47bd92a90e0425c6b311e1de931a1d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17507, "upload_time": "2019-03-29T13:41:49", "url": "https://files.pythonhosted.org/packages/de/0b/276a1a82fab391a64ab976ddc4f9ab6e2504e6bcd2bfd4e58fa85ea55964/ogscm-1.2.0.tar.gz" } ] }