{ "info": { "author": "Tormod Landet and the Ocellaris project contributors", "author_email": "tormod@landet.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Science/Research", "License :: OSI Approved :: Apache Software License", "Programming Language :: C++", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering :: Mathematics", "Topic :: Scientific/Engineering :: Physics" ], "description": "Ocellaris\n=========\n\nOcellaris is a mass-conserving DG FEM solver for sharp-interface multiphase\nfree-surface flows. Ocellaris can simulate water entry and exit of objects in\nocean waves with accurate capturing of the force on the object and the\nbehaviour of the free surface. Some examples of what Ocellaris can do,\nincluding videos of the results, are shown in the `Ocellaris Blog`_ on\n`www.ocellaris.org `_.\n\nOcellaris is implemented in Python and C++ with FEniCS_ as the backend for the\nmesh and finite element assembly. PETSc_ is used for solving the resulting\nlinear systems.\n\n.. contents:: Quick start\n\n.. _Ocellaris Blog: https://www.ocellaris.org/blog/\n.. _FEniCS: https://fenicsproject.org/\n.. _PETSc: https://www.mcs.anl.gov/petsc/\n\nOcellaris is named after the `Amphiprion Ocellaris `_\nclownfish and is written as part of a PhD project at the University of Oslo.\n\n.. figure:: https://www.ocellaris.org/figures/ocellaris_outlined_500.png\n :align: center\n :alt: Picture of an Ocellaris clownfish in a triangulated style\n\n\nInstallation and running\n------------------------\n\nOcellaris requires a full installation of FEniCS_ with the PETSc linear algebra\nbackend. You can install the dependencies yourself (you need at least dolfin,\nh5py, matplotlib and PyYAML), but the easiest way by far is to use a\npreconfigured Singularity or Docker container. More information on these and\ninstallation in general can be found in the `user guide`_.\n\nWhen Ocellaris is installed you can run the solver with an Ocellaris input\nfile::\n\n ocellaris INPUTFILE.INP\n\nExample input files can be found in the ``demos/`` sub-directory of the\nOcellaris source code and a description of the Ocellaris input file format and\nthe possible input parameters is given in the `user guide`_.\n\n.. _user guide: https://www.ocellaris.org/ocellaris/user_guide/user_guide.html\n\n\nFirst steps\n~~~~~~~~~~~\n\nTo test the code there are some demo input files in the ``demos/`` directory.\nComplete input files along with driver scripts are provided for several of the\nstandard benchmark cases like Kovasznay flow and the Taylor-Green vortex in the\n``cases/`` directory. More information can be found in the documentation which\nalso contains a description of the input file format.\n\nPlease feel free to test Ocellaris, but please keep in mind:\n\n- Ocellaris is in a state of constant development\n- Ocellaris is tested with FEniCS Version 2018.1. Earlier versions will NOT\n work, later version may possibly work.\n- This is an ongoing research project, do not expect results to be correct\n without proper validation!\n\n\nDocumentation\n-------------\n\nThe documentation can be found on the `Ocellaris web page `_.\n\n\nDevelopment\n-----------\n\nOcellaris is developed in Python and C++ on `Bitbucket `_\nby use of the Git version-control system. If you are reading this on github,\nplease be aware that you are seeing a mirror that could potentially be months\nout of date. The github mirror is only updated sporadically\u2014to trigger new\nSingularity and Docker Hub container builds. All pull requests and issues\nshould go to the Bitbucket repository. If you want to contribute to Ocellaris,\nplease read `the guide to contributing `_.\n\nOcellaris is automatically tested on `CircleCI `_\nand the current CI build status is |circleci_status|.\n\n.. |circleci_status| image:: https://circleci.com/bb/ocellarisproject/ocellaris.svg?style=svg\n :target: https://circleci.com/bb/ocellarisproject/ocellaris\n\n\nCopyright and license\n---------------------\n\nOcellaris is copyright Tormod Landet, 2014-2019, and the `Ocellaris project\ncontributors`_ from 2019\nand onwards. Ocellaris is licensed under the Apache 2.0 license, a permissive\nfree software license compatible with version 3 of the GNU GPL. See `License of\nOcellaris`_ for the details.\n\n.. _`Ocellaris project contributors`: https://www.ocellaris.org/contributors.html\n.. _`License of Ocellaris`: https://www.ocellaris.org/license.html\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://www.ocellaris.org/", "keywords": "fem fenics cfd dg navier-stokes multi-phase flow", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "ocellaris", "package_url": "https://pypi.org/project/ocellaris/", "platform": "", "project_url": "https://pypi.org/project/ocellaris/", "project_urls": { "Homepage": "https://www.ocellaris.org/" }, "release_url": "https://pypi.org/project/ocellaris/2019.1.0/", "requires_dist": [ "PyYAML (>=5.1)", "h5py", "numpy", "matplotlib", "meshio (>=2.0.0)", "raschii (>=1.0.2)", "yschema (>=1.0.2)", "fenics-dolfin (<2019.2,>=2018.1.0.dev0)" ], "requires_python": "", "summary": "A discontinuous Galerkin FEM solver for multiphase free surface flows", "version": "2019.1.0" }, "last_serial": 5273838, "releases": { "2017.1.dev1": [ { "comment_text": "", "digests": { "md5": "c22ed0e8074fd6fe77162cef97e54d24", "sha256": "1d61539dac3c9e27e7fc4d8a8a290051b3e6bc473f06032fa8a4e981dc561a17" }, "downloads": -1, "filename": "ocellaris-2017.1.dev1-py2-none-any.whl", "has_sig": false, "md5_digest": "c22ed0e8074fd6fe77162cef97e54d24", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 185839, "upload_time": "2017-04-04T09:00:54", "url": "https://files.pythonhosted.org/packages/9f/fa/0a52042488f1823b580c45b41052f80e9c1bb2ee48f77d1edf8704240cdb/ocellaris-2017.1.dev1-py2-none-any.whl" } ], "2018.1.0.dev0": [ { "comment_text": "", "digests": { "md5": "23937e60cf8436143f1b25bed846e0c2", "sha256": "d8fb3cb22395dd5c30e64ba80703e18a1cbd86bb6d7427de80c59e23f776938a" }, "downloads": -1, "filename": "ocellaris-2018.1.0.dev0-py3-none-any.whl", "has_sig": false, "md5_digest": "23937e60cf8436143f1b25bed846e0c2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 258594, "upload_time": "2018-01-23T08:58:05", "url": "https://files.pythonhosted.org/packages/86/b2/4fa0de16287083eb00bacef55e542ce580dc0c76a8bf1a50a93164676b7e/ocellaris-2018.1.0.dev0-py3-none-any.whl" } ], "2019.0.0": [ { "comment_text": "", "digests": { "md5": "5d27c6b8a196633dae0ecc15a8f3e131", "sha256": "868687c3d2606ac191c7593dea7af43e62eb46f27af08f807ec14f5d6b0c963b" }, "downloads": -1, "filename": "ocellaris-2019.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5d27c6b8a196633dae0ecc15a8f3e131", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 318491, "upload_time": "2019-01-10T15:07:45", "url": "https://files.pythonhosted.org/packages/77/12/259a4dea2353057d0ffc89650951d083d1b634c00fce7121ddcb54e9404a/ocellaris-2019.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1f2d4212c4beac4ae1d85b7c7a2b0987", "sha256": "cf15060b13fae3161584c685644633f2de6740d7f06edefc9949531fbd6de074" }, "downloads": -1, "filename": "ocellaris-2019.0.0.tar.gz", "has_sig": false, "md5_digest": "1f2d4212c4beac4ae1d85b7c7a2b0987", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 241822, "upload_time": "2019-01-10T15:07:46", "url": "https://files.pythonhosted.org/packages/de/61/37246460171811942b41b5fc86f1b3a8ae41f2d471b49f5e1741e7cfe564/ocellaris-2019.0.0.tar.gz" } ], "2019.0.1": [ { "comment_text": "", "digests": { "md5": "07639fa32e8b781412dd2f1241ee0f60", "sha256": "f95498ddbbe4a79685a20d58c93fbc2362bc5a259f698d59233ac7f4e5ae556c" }, "downloads": -1, "filename": "ocellaris-2019.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "07639fa32e8b781412dd2f1241ee0f60", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 318942, "upload_time": "2019-02-04T15:08:26", "url": "https://files.pythonhosted.org/packages/fd/d9/7167ed84e71282c13d74994ef288dcc7b6cddb6d66d636ecdf225d7945df/ocellaris-2019.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "03b7c226d44206a4a5a201cdc20dcdac", "sha256": "def6cdc05f4865b5df62f05c6f033e6067405e70068c0f82bc0def8c206f6e5d" }, "downloads": -1, "filename": "ocellaris-2019.0.1.tar.gz", "has_sig": false, "md5_digest": "03b7c226d44206a4a5a201cdc20dcdac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 242302, "upload_time": "2019-02-04T15:08:28", "url": "https://files.pythonhosted.org/packages/3a/14/26831e0819a2b53a91165e3db220f8303992d607d12a8c80c350d2865917/ocellaris-2019.0.1.tar.gz" } ], "2019.0.2": [ { "comment_text": "", "digests": { "md5": "4f6874e961f0a47e3192122ef99ae7aa", "sha256": "03a8e3d070ebee1a2d0de55d97c5180da5efc2adcff1147c9ded44442dfc2100" }, "downloads": -1, "filename": "ocellaris-2019.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "4f6874e961f0a47e3192122ef99ae7aa", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 331239, "upload_time": "2019-03-21T15:45:59", "url": "https://files.pythonhosted.org/packages/a0/2d/4ca798124d6f12f00a20037a86eefd19bd992faca7fa3a6e5f5c32ca92c5/ocellaris-2019.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b7b624a82ab17a7e41bd1b7f31d105b1", "sha256": "e4c6ca794632a49d4a1156b432d9e994acb6f8e48484091e2e294cc128d28f1f" }, "downloads": -1, "filename": "ocellaris-2019.0.2.tar.gz", "has_sig": false, "md5_digest": "b7b624a82ab17a7e41bd1b7f31d105b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 243229, "upload_time": "2019-03-21T15:46:01", "url": "https://files.pythonhosted.org/packages/27/bc/bcf6a7ff49918adc55b7fcfa573f633bcfbad91641bf432625ed40bf7d38/ocellaris-2019.0.2.tar.gz" } ], "2019.1.0": [ { "comment_text": "", "digests": { "md5": "7bd0de612d1ab3f459878207bfcb947f", "sha256": "7b54936ae12833f2be5817ea8013aac51fcb9dc177d95c2437701f434c9f9e4a" }, "downloads": -1, "filename": "ocellaris-2019.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7bd0de612d1ab3f459878207bfcb947f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 330735, "upload_time": "2019-05-15T18:43:34", "url": "https://files.pythonhosted.org/packages/13/89/57cab0695181313e75e9cf239d62c81f2e9a9c19047cc1fda19b0cbc2110/ocellaris-2019.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8bac330a781033aca68888a20156983b", "sha256": "55e3fb3dbc35e6eef88e07a21e2cefb8dda529095f5b092fa5680407b85ab8f6" }, "downloads": -1, "filename": "ocellaris-2019.1.0.tar.gz", "has_sig": false, "md5_digest": "8bac330a781033aca68888a20156983b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 242782, "upload_time": "2019-05-15T18:43:37", "url": "https://files.pythonhosted.org/packages/5d/3f/b1fc9eaad8e820d14aed4766c491b5125a865932868786c54ee17551520f/ocellaris-2019.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7bd0de612d1ab3f459878207bfcb947f", "sha256": "7b54936ae12833f2be5817ea8013aac51fcb9dc177d95c2437701f434c9f9e4a" }, "downloads": -1, "filename": "ocellaris-2019.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7bd0de612d1ab3f459878207bfcb947f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 330735, "upload_time": "2019-05-15T18:43:34", "url": "https://files.pythonhosted.org/packages/13/89/57cab0695181313e75e9cf239d62c81f2e9a9c19047cc1fda19b0cbc2110/ocellaris-2019.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8bac330a781033aca68888a20156983b", "sha256": "55e3fb3dbc35e6eef88e07a21e2cefb8dda529095f5b092fa5680407b85ab8f6" }, "downloads": -1, "filename": "ocellaris-2019.1.0.tar.gz", "has_sig": false, "md5_digest": "8bac330a781033aca68888a20156983b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 242782, "upload_time": "2019-05-15T18:43:37", "url": "https://files.pythonhosted.org/packages/5d/3f/b1fc9eaad8e820d14aed4766c491b5125a865932868786c54ee17551520f/ocellaris-2019.1.0.tar.gz" } ] }