{ "info": { "author": "Katy Barnhart", "author_email": "barnhark@colorado.edu", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Scientific/Engineering :: Physics" ], "description": "[![Documentation Status](https://readthedocs.org/projects/umami/badge/?version=latest)](https://umami.readthedocs.io/en/latest/?badge=latest)\n[![Build Status](https://travis-ci.org/TerrainBento/umami.svg?branch=master)](https://travis-ci.org/TerrainBento/umami)\n[![Build status](https://ci.appveyor.com/api/projects/status/0ehba569dttgsuyv?svg=true)](https://ci.appveyor.com/project/kbarnhart/umami)\n[![Coverage Status](https://coveralls.io/repos/github/TerrainBento/umami/badge.svg?branch=master)](https://coveralls.io/github/TerrainBento/umami?branch=master)\n[![Anaconda-Server Badge](https://anaconda.org/conda-forge/umami/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TerrainBento/umami/master?filepath=notebooks%2FWelcome.ipynb)\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.01776/status.svg)](https://doi.org/10.21105/joss.01776)\n\n\n# What is it?\n\nUmami is a package for calculating objective functions or objective function\ncomponents for Earth surface dynamics modeling. It was designed to work well\nwith\n[terrainbento](https://github.com/TerrainBento/terrainbento) and other models built with the\n[Landlab Toolkit](https://github.com/landlab/landlab). Examples can be\nfound in the `notebooks` directory (or on Binder\n[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/TerrainBento/umami/master?filepath=notebooks%2FWelcome.ipynb)\n).\n\nUmami offers two primary classes:\n* a [`Residual`](https://umami.readthedocs.io/en/latest/umami.residual.html#Residual),\nwhich represents the difference between model and data, and\n* a [`Metric`](https://umami.readthedocs.io/en/latest/umami.metric.html),\nwhich is a calculated value on either model or data.\n\nThe set of currently supported calculations are found in the [`umami.calculations`](https://umami.readthedocs.io/en/latest/umami.calculations.html) submodule.\n\n# What does it do well?\n\nUmami was designed to provide an input-file based interface for calculating\nsingle-value landscape metrics for use in model analysis. This supports\nreproducible analysis and systematic variation in metric construction. When\nused with `terrainbento` one input file can describe the model run, and one\ninput file can describe the model assessment or model-data comparison. This\nstreamlines model analysis applications. Umami also provides multiple output\nformats (YAML and Dakota), the latter of which is designed to interface with\nSandia National Laboratory's [Dakota package](https://dakota.sandia.gov).\n\nTo get a sense of how it is meant to be used, check out the\n[notebooks on Binder](https://mybinder.org/v2/gh/TerrainBento/umami/master?filepath=notebooks%2FWelcome.ipynb)\nand the [API documentation](https://umami.readthedocs.io/en/latest/).\n\n# Where to get it\n\nTo install the release version of umami (this is probably what you want) we\nsupport [conda](https://anaconda.org/conda-forge/umami) and\n[pip](https://pypi.org/project/umami/) package management.\n\n## Using conda\n\nOpen a terminal and execute the following:\n\n```\n$ conda config --add channels conda-forge\n$ conda install umami\n```\n\n## Using pip\n\nOpen a terminal and execute the following:\n\n```\n$ pip install umami\n```\n\n## From source code\n\nThe source code is housed on [GitHub](https://github.com/TerrainBento/umami).\nTo install the umami from source code we recommend creating a conda environment.\n\n```\n$ git clone https://github.com/TerrainBento/umami.git\n$ cd umami\n$ conda env create -f environment-dev.yml\n$ conda activate umami-dev\n$ python setup.py install\n```\n\nIf you are interested in developing umami, please check out the\n[development practices](https://umami.readthedocs.io/en/latest/development_practices.html)\npage.\n\n# Read the documentation\n\nDocumentation is housed on [ReadTheDocs](https://umami.readthedocs.io).\n\n# License\n\n[MIT](https://github.com/TerrainBento/umami/blob/master/LICENSE)\n\n# Report issues and get help\n\nUmami uses Github Issue as a single point of contact for users and developers.\nTo ask a question, report a bug, make a feature request, or to get in touch for\nany reason, please make [an Issue](https://github.com/TerrainBento/umami/issues).\n\n# Contribute to umami\n\nAll contributions are welcome and appreciated. Feel free to:\n\n- Make [an issue](https://github.com/TerrainBento/umami/issues) to ask a\n question. Your question will help others in the future.\n- Make [an issue](https://github.com/TerrainBento/umami/issues) to report a\n bug or a potential improvement. We will work to fix it. If you have an idea\n about how to fix it, please feel free to propose it, or make a Pull Request. \n- [Fork the repository](https://help.github.com/en/articles/fork-a-repo), make\n changes to the source code on a\n [development branch](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow),\n and submit a Pull Request to have your changes brought into the umami\n repository. **No contribution to the code base or documentation is too small.**\n\nContributors and maintainers to this project are are expected to abide the [Contributor Code of Conduct](https://github.com/TerrainBento/umami/blob/master/CODE_OF_CONDUCT.md).\n\n# Cite umami\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.01776/status.svg)](https://doi.org/10.21105/joss.01776)\n\nUmami is described by a Journal of Open Source Software paper. If you use umami in your research, please cite it. \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/TerrainBento/umami/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "umami", "package_url": "https://pypi.org/project/umami/", "platform": "", "project_url": "https://pypi.org/project/umami/", "project_urls": { "Homepage": "https://github.com/TerrainBento/umami/" }, "release_url": "https://pypi.org/project/umami/2.0.0/", "requires_dist": [ "scipy", "numpy", "landlab (>=2.0.0b4)" ], "requires_python": ">=3", "summary": "Umami calculates landscape metrics", "version": "2.0.0", "yanked": false, "yanked_reason": null }, "last_serial": 7219940, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "9e5c88da2e83aa05da2b63f376ff6d47", "sha256": "238d6b201331e7d2106e5696d6b8ae9499f1b0f5e197feb6f7f3c2077dd93d36" }, "downloads": -1, "filename": "umami-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9e5c88da2e83aa05da2b63f376ff6d47", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 23334, "upload_time": "2019-09-02T17:52:28", "upload_time_iso_8601": "2019-09-02T17:52:28.623824Z", "url": "https://files.pythonhosted.org/packages/15/ff/8ef929af9fb2c5611b9588576f51fc7f6a939a3889289cb6f8886e998ea5/umami-0.1.1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "4fcb16ea47bc1d3b9417b53dd54563d4", "sha256": "879f8d3eda3d6348be3cd1f951f1bcf4817eaaaae8b8e634eae81c04255d7277" }, "downloads": -1, "filename": "umami-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "4fcb16ea47bc1d3b9417b53dd54563d4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 24846, "upload_time": "2019-09-13T12:08:39", "upload_time_iso_8601": "2019-09-13T12:08:39.394725Z", "url": "https://files.pythonhosted.org/packages/e2/c9/1c4858f8a67119819e867677892cba4a9da0a6a824be5c9ca3fd1addcbd8/umami-0.1.2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "e61917079533816b413f148a4e516007", "sha256": "5e33f6f80f65f8dfec580fc41b46d6bd8872541186b3732e12915d62479845bd" }, "downloads": -1, "filename": "umami-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "e61917079533816b413f148a4e516007", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 24855, "upload_time": "2019-10-07T19:52:28", "upload_time_iso_8601": "2019-10-07T19:52:28.438806Z", "url": "https://files.pythonhosted.org/packages/38/b7/157fb76582aca42c052f5833fdc33b1fc851c34724c645a88c08c2d00cd7/umami-0.1.3-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "ee18bdb2388bb319034314671bd8202f", "sha256": "2b366b3ea1e8dbd5ff84d74490b72751fc1dbfe4274959e0daa91e66edf770bb" }, "downloads": -1, "filename": "umami-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "ee18bdb2388bb319034314671bd8202f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 25186, "upload_time": "2019-10-15T00:19:50", "upload_time_iso_8601": "2019-10-15T00:19:50.192410Z", "url": "https://files.pythonhosted.org/packages/68/03/57acbc8b4a86037170b33efc95c847d88d09b16f483149b34f4b72da1599/umami-1.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "7d3fd5f12c78c391da7a8826f6e6612c", "sha256": "6acea616a6abff28db3d6572825b8ab2187072be540d7a7cbf133b024173c926" }, "downloads": -1, "filename": "umami-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7d3fd5f12c78c391da7a8826f6e6612c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 25182, "upload_time": "2019-10-29T03:19:33", "upload_time_iso_8601": "2019-10-29T03:19:33.222742Z", "url": "https://files.pythonhosted.org/packages/24/16/3f6baeaa1589390cfac6c30897720e20a3be851659af8196747a0643e0d4/umami-1.0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "11558ee4b53942a86a812b58aa66e3f0", "sha256": "c6b76833de65f876aa4a22f4bcfc8006de131e42f2446ce9fca831ca755e6e27" }, "downloads": -1, "filename": "umami-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "11558ee4b53942a86a812b58aa66e3f0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 25181, "upload_time": "2020-01-02T18:14:40", "upload_time_iso_8601": "2020-01-02T18:14:40.779460Z", "url": "https://files.pythonhosted.org/packages/04/8c/8a9d7f9847f7239da97cdff2d73b7a93d7c3a7a0b70d6d3bd61cf5dfe9e2/umami-1.0.2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "8b0aeae004d23a2233a2a5cd2fea0d52", "sha256": "082bede82c4b872b0b5e45d5f32d3e89c6d80b886a25aec20d0d945b042d2a5e" }, "downloads": -1, "filename": "umami-2.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8b0aeae004d23a2233a2a5cd2fea0d52", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 26430, "upload_time": "2020-05-11T23:23:33", "upload_time_iso_8601": "2020-05-11T23:23:33.642937Z", "url": "https://files.pythonhosted.org/packages/ad/e1/fdab95c42d747d9ab5fe8331e9f39a5c3d94027bfb1b10a7c69414a85f17/umami-2.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "2.0.0b1": [ { "comment_text": "", "digests": { "md5": "c2dfd353c3bdf6e2fe776f7e77a0d4ac", "sha256": "c44cc446af9a983af137ed1071f01025bdd24084c69fa758a8984135fcc14c47" }, "downloads": -1, "filename": "umami-2.0.0b1-py3-none-any.whl", "has_sig": false, "md5_digest": "c2dfd353c3bdf6e2fe776f7e77a0d4ac", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 25212, "upload_time": "2020-02-16T03:15:58", "upload_time_iso_8601": "2020-02-16T03:15:58.041926Z", "url": "https://files.pythonhosted.org/packages/6d/cc/25641e541b42341a3c944c8871e968b8b749291bfe78dcee38a26d62a343/umami-2.0.0b1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "2.0.0b2": [ { "comment_text": "", "digests": { "md5": "67232b4196b38496d2ed1b0723befd55", "sha256": "ca1b5f5d90dbca008f584b654ff34e829f94b6bf639027b5fa8c6f863f25f4eb" }, "downloads": -1, "filename": "umami-2.0.0b2-py3-none-any.whl", "has_sig": false, "md5_digest": "67232b4196b38496d2ed1b0723befd55", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 26464, "upload_time": "2020-02-18T01:06:01", "upload_time_iso_8601": "2020-02-18T01:06:01.193501Z", "url": "https://files.pythonhosted.org/packages/e6/a6/bbeecdb8cf44ab501a5d034a3cb7e2e2b49a738a1406565e7fcd7931a826/umami-2.0.0b2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "2.0.0b3": [ { "comment_text": "", "digests": { "md5": "83c16dec551cdee34d8e09da16d3ffda", "sha256": "39eb83dc815aae6fe1e30df2c92752d6a9f2a1f0985dc3edd8f919f5c4938264" }, "downloads": -1, "filename": "umami-2.0.0b3-py3-none-any.whl", "has_sig": false, "md5_digest": "83c16dec551cdee34d8e09da16d3ffda", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 26452, "upload_time": "2020-03-02T14:28:44", "upload_time_iso_8601": "2020-03-02T14:28:44.379786Z", "url": "https://files.pythonhosted.org/packages/bf/4b/12bc0135aed20bc4e178a975d286654f1ab8c15b3964f9bdfff176e88651/umami-2.0.0b3-py3-none-any.whl", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8b0aeae004d23a2233a2a5cd2fea0d52", "sha256": "082bede82c4b872b0b5e45d5f32d3e89c6d80b886a25aec20d0d945b042d2a5e" }, "downloads": -1, "filename": "umami-2.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8b0aeae004d23a2233a2a5cd2fea0d52", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 26430, "upload_time": "2020-05-11T23:23:33", "upload_time_iso_8601": "2020-05-11T23:23:33.642937Z", "url": "https://files.pythonhosted.org/packages/ad/e1/fdab95c42d747d9ab5fe8331e9f39a5c3d94027bfb1b10a7c69414a85f17/umami-2.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }