# Espresso
[](https://pypi.org/project/cofi-espresso/)
[](https://github.com/inlab-geo/espresso/actions/workflows/build_wheels.yml)
[](https://cofi-espresso.readthedocs.io/en/latest/?badge=latest)
[](https://join.slack.com/t/inlab-community/shared_invite/zt-1ejny069z-v5ZyvP2tDjBR42OAu~TkHg)
## Introduction
**E**arth **S**cience **PR**oblems for the **E**valuation of **S**trategies,
**S**olvers and **O**ptimizers (Espresso) is a collection of datasets, and
associated simulation codes, spanning a wide range of geoscience problems.
Together they form a suite of real-world test problems that can be used to
support the development, evaluation and benchmarking of a wide range of tools
and algorithms for inference, inversion and optimisation. All problems are
designed to share a common interface, so that changing from one test problem
to another requires changing one line of code.
The Espresso project is a community effort - if you think it sounds useful,
please consider contributing an example or two from your own research. The project
is currently being coordinated by InLab, with support from the CoFI development
team.
For more information, please visit our documentation (coming soon).
## Installation
```console
$ pip install cofi-espresso
```
Check Espresso documentation -
[installation page](https://cofi-espresso.readthedocs.io/en/latest/installation.html)
for details on dependencies and setting up with virtual environments.
## Basic usage
Once installed, each test problem can be imported using the following command:
```python
from cofi_espresso import <testproblem>
```
Replace ``<testproblem>`` with one of the following currently available problems:
- `GravityDensity`
- `SimpleRegression`
- `XrayTomography`
Once a problem is imported, its main functions can be called using the same
structure for each problem. For instance:
```python
from cofi_espresso import GravityDensity
problem = GravityDensity(example_number=1)
model = problem.good_model
data = problem.data
pred = problem.forward(model)
fig_model = problem.plot_model(model)
fig_data = problem.plot_data(data, pred)
```
You can access related metadata programatically:
```python
print(GravityDensity.problem_title)
print(GravityDensity.problem_short_description)
print(GravityDensity.author_names)
```
Other problem-specific parameters can be accessed through the problem instance. For instance:
```python
print(problem.m)
print(problem.rec_coords)
```
Which additional values are set is highly problem-specific and we suggest to
consult the
[Espresso Documentation on the problems](https://cofi-espresso.readthedocs.io/en/latest/user_guide/contrib/index.html).
## Contributing
Interested in contributing? Please check out our [contributor's guide](https://cofi-espresso.readthedocs.io/en/latest/contributor_guide/ways.html).
## Licence
Espresso is a community driven project to create a large suite of forward
simulations to enable researchers to get example data without the need to
understand each individual problem in detail.
Licensing is done individually by each contributor. If a contributor wants to freely share their code example we recommend the MIT licence or a
2-clause BSD licence. To determine the licence of an existing Espresso
problem, please consult the documentation section of that problem.
All the other core functions of Espresso written by InLab Espresso developer
team are distributed under a 2-clause BSD licence. A copy of this licence is
provided with distributions of the software.
Raw data
{
"_id": null,
"home_page": "",
"name": "cofi-espresso",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "inversion,inference,python package,geoscience,geophysics",
"author": "InLab, Espresso development team",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c4/18/03cc955453e26e94b76a36ad0f272b1f4841e9754ab0fa551718f2413050/cofi_espresso-0.0.2.dev0.tar.gz",
"platform": null,
"description": "# Espresso\n\n[](https://pypi.org/project/cofi-espresso/)\n[](https://github.com/inlab-geo/espresso/actions/workflows/build_wheels.yml)\n[](https://cofi-espresso.readthedocs.io/en/latest/?badge=latest)\n[](https://join.slack.com/t/inlab-community/shared_invite/zt-1ejny069z-v5ZyvP2tDjBR42OAu~TkHg)\n\n## Introduction\n\n**E**arth **S**cience **PR**oblems for the **E**valuation of **S**trategies, \n**S**olvers and **O**ptimizers (Espresso) is a collection of datasets, and \nassociated simulation codes, spanning a wide range of geoscience problems. \nTogether they form a suite of real-world test problems that can be used to \nsupport the development, evaluation and benchmarking of a wide range of tools\nand algorithms for inference, inversion and optimisation. All problems are \ndesigned to share a common interface, so that changing from one test problem\nto another requires changing one line of code. \n\nThe Espresso project is a community effort - if you think it sounds useful,\nplease consider contributing an example or two from your own research. The project\nis currently being coordinated by InLab, with support from the CoFI development\nteam.\n\nFor more information, please visit our documentation (coming soon).\n\n\n## Installation\n\n```console\n$ pip install cofi-espresso\n```\n\nCheck Espresso documentation - \n[installation page](https://cofi-espresso.readthedocs.io/en/latest/installation.html) \nfor details on dependencies and setting up with virtual environments.\n\n## Basic usage\n\nOnce installed, each test problem can be imported using the following command:\n\n```python\nfrom cofi_espresso import <testproblem>\n```\n\nReplace ``<testproblem>`` with one of the following currently available problems:\n\n- `GravityDensity`\n- `SimpleRegression`\n- `XrayTomography`\n\nOnce a problem is imported, its main functions can be called using the same \nstructure for each problem. For instance:\n\n```python\nfrom cofi_espresso import GravityDensity\n\nproblem = GravityDensity(example_number=1)\nmodel = problem.good_model\ndata = problem.data\npred = problem.forward(model)\nfig_model = problem.plot_model(model)\nfig_data = problem.plot_data(data, pred)\n```\n\nYou can access related metadata programatically:\n\n```python\nprint(GravityDensity.problem_title)\nprint(GravityDensity.problem_short_description)\nprint(GravityDensity.author_names)\n```\n\nOther problem-specific parameters can be accessed through the problem instance. For instance:\n\n```python\nprint(problem.m)\nprint(problem.rec_coords)\n```\n\nWhich additional values are set is highly problem-specific and we suggest to \nconsult the \n[Espresso Documentation on the problems](https://cofi-espresso.readthedocs.io/en/latest/user_guide/contrib/index.html).\n\n\n## Contributing\n\nInterested in contributing? Please check out our [contributor's guide](https://cofi-espresso.readthedocs.io/en/latest/contributor_guide/ways.html).\n\n\n## Licence\n\nEspresso is a community driven project to create a large suite of forward\nsimulations to enable researchers to get example data without the need to \nunderstand each individual problem in detail.\n\nLicensing is done individually by each contributor. If a contributor wants to freely share their code example we recommend the MIT licence or a \n2-clause BSD licence. To determine the licence of an existing Espresso\nproblem, please consult the documentation section of that problem.\n\nAll the other core functions of Espresso written by InLab Espresso developer\nteam are distributed under a 2-clause BSD licence. A copy of this licence is\nprovided with distributions of the software.\n",
"bugtrack_url": null,
"license": "",
"summary": "Earth Science PRoblems for the Evaluation of Strategies, Solvers and Optimizers",
"version": "0.0.2.dev0",
"split_keywords": [
"inversion",
"inference",
"python package",
"geoscience",
"geophysics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a68e4578b19742296f170b33f8f4316e4b15349c79a5094854ef77c4cd78e08",
"md5": "f1f051beef90eee6efe214644591ac91",
"sha256": "9ab3fb98222b46187e4877d685d1ef41fcaa4d84bf50499855bca977473dad10"
},
"downloads": -1,
"filename": "cofi_espresso-0.0.2.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f1f051beef90eee6efe214644591ac91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 956067,
"upload_time": "2023-01-17T04:37:52",
"upload_time_iso_8601": "2023-01-17T04:37:52.859528Z",
"url": "https://files.pythonhosted.org/packages/2a/68/e4578b19742296f170b33f8f4316e4b15349c79a5094854ef77c4cd78e08/cofi_espresso-0.0.2.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c41803cc955453e26e94b76a36ad0f272b1f4841e9754ab0fa551718f2413050",
"md5": "8b15efb62aeba76492d6cf6c296c895c",
"sha256": "c874b36076ea646a3f9d19e8896198a28c8a1db28ad704c7d120c044963d1fa6"
},
"downloads": -1,
"filename": "cofi_espresso-0.0.2.dev0.tar.gz",
"has_sig": false,
"md5_digest": "8b15efb62aeba76492d6cf6c296c895c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 940360,
"upload_time": "2023-01-17T04:37:54",
"upload_time_iso_8601": "2023-01-17T04:37:54.755479Z",
"url": "https://files.pythonhosted.org/packages/c4/18/03cc955453e26e94b76a36ad0f272b1f4841e9754ab0fa551718f2413050/cofi_espresso-0.0.2.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 04:37:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "cofi-espresso"
}
JSON