Skip to content

Adding JOSS paper #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daavid00 merged 1 commit into from
Sep 10, 2026
Merged

Adding JOSS paper #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/ci_pycopm_docker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
name: Docker

on:
pull_request:
push:
branches:
- main

jobs:
run-pycopm-docker:
Expand Down
23 changes: 17 additions & 6 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
cff-version: "1.2.0"
title: "pycopm: An open-source tool to tailor OPM Flow geological models"
authors:
- family-names: Landa-Marbán
given-names: David
Expand All @@ -8,14 +7,26 @@ contact:
- family-names: Landa-Marbán
given-names: David
orcid: "https://orcid.org/0000-0002-3343-1005"
message: "If you use this software, please cite it as below."
doi: 10.6084/m9.figshare.33321138.v2
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Landa-Marbán
given-names: David
orcid: "https://orcid.org/0000-0002-3343-1005"
title: "pycopm: An open-source tool to tailor OPM Flow geological models"
year: 2026
doi: 10.48550/arXiv.2602.11777
journal: arXiv preprint
date-published: 2026-09-09
doi: 10.21105/joss.10124
issn: 2475-9066
issue: 125
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 10124
title: "pycopm: An open-source tool to tailor OPM Flow geological
models"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.10124"
volume: 11
title: "pycopm: An open-source tool to tailor OPM Flow geological
models"
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12%20to%203.14-blue.svg"></a>
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.10124/status.svg)](https://doi.org/10.21105/joss.10124)
<img src="docs/text/figs/pycopm.png" width="900" height="380">

# pycopm: An open-source tool to tailor OPM Flow geological models.
Expand Down Expand Up @@ -54,7 +55,7 @@ See the [_examples_](https://cssr-tools.github.io/pycopm/examples.html) in the [

## Citing

* Landa-Marbán, D., 2026. pycopm: An open-source tool to tailor OPM Flow geological models. [https://arxiv.org/abs/2602.11777](https://arxiv.org/abs/2602.11777).
* Landa-Marbán, D., 2026. pycopm: An open-source tool to tailor OPM Flow geological models. Journal of Open Source Software, 11(125), 10124, https://doi.org/10.21105/joss.10124.

## Publications
The following is a list of manuscripts in which _pycopm_ is used:
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/core/pycopm.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/coarsening.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/files_writer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/generate_decks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/input_values.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/parser_deck.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/refinement.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/runs_executer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/terminal.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/transformation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pycopm/utils/vicinity.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../../../_static/searchtools.js"></script>
Expand Down
5 changes: 2 additions & 3 deletions docs/_sources/introduction.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,8 @@ Citation

If **pycopm** contributes to published work, cite the project paper:

Landa-Marbán, D. (2026). *pycopm: An open-source tool to tailor OPM Flow
geological models*. arXiv:2602.11777.
https://doi.org/10.48550/arXiv.2602.11777.
Landa-Marbán, D. 2026. *pycopm: An open-source tool to tailor OPM Flow
geological models*. Journal of Open Source Software, 11(125), 10124, https://doi.org/10.21105/joss.10124

Where to continue
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/modules.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.core.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.core.pycopm.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.coarsening.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.files_writer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.generate_decks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.input_values.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.parser_deck.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.refinement.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.runs_executer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.terminal.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.transformation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/pycopm.utils.vicinity.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/command-line.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/complete-reference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration_file.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/configuration-workflows.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/drogon.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2026.4" />
<meta name="docbuild:last-update" content="2026-09-09"/>
<meta name="docbuild:last-update" content="2026-09-10"/>


<script src="../_static/searchtools.js"></script>
Expand Down
Loading