Merge pull request #110 from daavid00/paperReference

JOSS paper Markdown and citation

CITATION.cff

@@ -0,0 +1,38 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Landa-Marbán
+  given-names: David
+  orcid: "https://orcid.org/0000-0002-3343-1005"
+- family-names: Sandve
+  given-names: Tor H.
+  orcid: "https://orcid.org/0000-0002-3267-8276"
+contact:
+- family-names: Landa-Marbán
+  given-names: David
+  orcid: "https://orcid.org/0000-0002-3343-1005"
+doi: 10.6084/m9.figshare.28284845.v1
+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"
+  - family-names: Sandve
+    given-names: Tor H.
+    orcid: "https://orcid.org/0000-0002-3267-8276"
+  date-published: 2025-01-30
+  doi: 10.21105/joss.07357
+  issn: 2475-9066
+  issue: 105
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 7357
+  title: "pyopmspe11: A Python framework using OPM Flow for the SPE11
+    benchmark project"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.07357"
+  volume: 10
+title: "pyopmspe11: A Python framework using OPM Flow for the SPE11
+  benchmark project"

README.md

@@ -2,6 +2,7 @@
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.8%20to%203.12-blue.svg"></a>
 [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/license/mit/)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07357/status.svg)](https://doi.org/10.21105/joss.07357)
 
 # pyopmspe11: A Python framework using OPM Flow for the SPE11 benchmark project
 
@@ -20,15 +21,15 @@ To install the _pyopmspe11_ executable from the development version:
 pip install git+https://github.com/OPM/pyopmspe11.git
 ```
 
-If you are interested in a specific version (e.g., v2024.04) or in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:
+If you are interested in a specific version (e.g., v2024.10) or in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:
 
 ```bash
 # Clone the repo
 git clone https://github.com/OPM/pyopmspe11.git
 # Get inside the folder
 cd pyopmspe11
-# For a specific version (e.g., v2024.04), or skip this step (i.e., edge version)
-git checkout v2024.04
+# For a specific version (e.g., v2024.10), or skip this step (i.e., edge version)
+git checkout v2024.10
 # Create virtual environment (to specific Python, python3.12 -m venv vpyopmspe11)
 python3 -m venv vpyopmspe11
 # Activate virtual environment
@@ -52,11 +53,11 @@ Run `pyopmspe11 --help` to see all possible command line
 argument options. Inside the `configuration_file` you provide the path to the flow executable and simulation parameters. See the .txt and .toml files in the [_examples_](https://github.com/OPM/pyopmspe11/tree/main/examples), [_benchmark_](https://github.com/OPM/pyopmspe11/tree/main/benchmark), and [_tests_](https://github.com/OPM/pyopmspe11/tree/main/tests/configs) folders.
 
 ## Getting started
-See the [_examples_](https://OPM.github.io/pyopmspe11/examples.html) in the [_documentation_](https://OPM.github.io/pyopmspe11/introduction.html). 
+See the [_examples_](https://OPM.github.io/pyopmspe11/examples.html) in the [_documentation_](https://OPM.github.io/pyopmspe11/introduction.html) and the [_journal paper_](https://joss.theoj.org/papers/10.21105/joss.07357).
 
 ## About pyopmspe11
 The pyopmspe11 package is being funded by the [_HPC Simulation Software for the Gigatonne Storage Challenge project_](https://www.norceresearch.no/en/projects/hpc-simulation-software-for-the-gigatonne-storage-challenge) [project number 622059] and [_Center for Sustainable Subsurface Resources (CSSR)_](https://cssr.no) 
 [project no. 331841].
-This is work in progress. [_Here_](https://www.spe.org/en/csp/) is the link to the SPE11 details.
+[_Here_](https://www.spe.org/en/csp/) is the link to the SPE11 details.
 Contributions are more than welcome using the fork and pull request approach.
 For a new feature, please request this by raising an issue.

src/pyopmspe11/__init__.py

@@ -2,4 +2,4 @@
 Code version.
 """
 
-__version__ = "2024.10-pre"
+__version__ = "2025.04-pre"

src/pyopmspe11/visualization/data.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: MIT
 # pylint: disable=C0302, R0912, R0914, R0801
 
-""""
+""" "
 Script to write the benchmark data
 """
 

src/pyopmspe11/visualization/plotting.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: MIT
 # pylint: disable=R0912, R0801
 
-""""
+""" "
 Script to plot the results
 """