You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Contributions are more than welcome using the fork and pull request approach
17
17
1.**pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
18
18
1.**mypy --ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
19
19
1.**pytest --cov=pyopmspe11 --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
20
-
1.**pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then copy all content from the docs/_build/html/ folder and replace the files in the [_docs_](https://github.com/cssr-tools/pyopmspe11/tree/main/docs) folder)
20
+
1.**pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then delete all content from the [_docs_](https://github.com/cssr-tools/pyopmspe11/tree/main/docs) folder except [_Makefile_](https://github.com/OPM/pyopmspe11/blob/main/docs/Makefile), [_text_](https://github.com/OPM/pyopmspe11/blob/main/docs/text), and [_.nojekyll_](https://github.com/OPM/pyopmspe11/blob/main/docs/.nojekyll), after copy all contents from the docs/_build/html/ folder, and finally paste them in the [_docs_](https://github.com/cssr-tools/pyopmspe11/tree/main/docs) folder)
21
21
* Tip: See the [_CI.yml_](https://github.com/cssr-tools/pyopmspe11/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pyopmspe11/actions) for installation of pyopmspe11, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.10.
22
22
1. Squash your commits into a single commit (see this [_nice tutorial_](https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa) if you are not familiar with this)
Copy file name to clipboardexpand all lines: docs/_sources/about.rst.txt
+6-2
Original file line number
Diff line number
Diff line change
@@ -7,5 +7,9 @@ About pyopmspe11
7
7
8
8
This **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>`_
9
9
[project number 622059] and `Center for Sustainable Subsurface Resources (CSSR) <https://cssr.no>`_ [project no. 331841].
10
-
This is work in progress. `Here <https://www.spe.org/en/csp/>`_ is the link to the spe11 details.
11
-
Contributions are more than welcome using the fork and pull request approach.
10
+
11
+
`Here <https://www.spe.org/en/csp/>`_ is the link to the spe11 details.
12
+
13
+
Contributions are more than welcome using the fork and pull request approach.
14
+
15
+
For a new feature, please request this by raising an issue.
Contributions are more than welcome using the fork and pull request approach 🙂 (if you are not familiar with this approach,
6
+
please visit `GitHub Docs PRs <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests>`_ for an extended
7
+
documentation about collaborating with pull request; also, looking at previous merged pull requests helps to get familiar with this).
8
+
9
+
============
10
+
Ground Rules
11
+
============
12
+
13
+
- We use Black code formatting
14
+
- We use Pylint
15
+
- We document our code
16
+
17
+
==========================
18
+
Contribute to the software
19
+
==========================
20
+
21
+
#. Work on your own fork of the main repo
22
+
#. In the main repo execute:
23
+
24
+
#. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/pyopmspe11/blob/main/dev-requirements.txt>`_; in addition, both opm Python and LaTeX are required, then for not macOs users run **pip install opm** and **sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super**, or else follow the instructions in `macOS installation <https://cssr-tools.github.io/pyopmspe11/installation.html#source-build-in-macos>`_)
25
+
#. **black src/ tests/** (this formats the code)
26
+
#. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
27
+
#. **mypy --ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
28
+
#. **pytest --cov=pyopmspe11 --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request; to save the files, add the flag **--basetemp=test_outputs**)
29
+
#. **pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then delete all content from the `docs <https://github.com/cssr-tools/pyopmspe11/tree/main/docs>`_ folder except `Makefile <https://github.com/OPM/pyopmspe11/blob/main/docs/Makefile>`_, `text <https://github.com/OPM/pyopmspe11/blob/main/docs/text>`_, and `.nojekyll <https://github.com/OPM/pyopmspe11/blob/main/docs/.nojekyll>`_, after copy all contents from the docs/_build/html/ folder, and finally paste them in the `docs <https://github.com/cssr-tools/pyopmspe11/tree/main/docs>`_ folder)
30
+
31
+
.. tip::
32
+
See the `CI.yml <https://github.com/cssr-tools/pyopmspe11/blob/main/.github/workflows/CI.yml>`_ script and the `Actions <https://github.com/cssr-tools/pyopmspe11/actions>`_ for installation of pyopmspe11, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.10.
33
+
34
+
#. Squash your commits into a single commit (see this `nice tutorial <https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa>`_ if you are not familiar with this)
35
+
#. Push your commit and make a pull request
36
+
#. The maintainers will review the pull request, and if the contribution is accepted, then it will be merge to the main repo
37
+
38
+
============================
39
+
Reporting issues or problems
40
+
============================
41
+
42
+
#. Issues or problems can be raised by creating a `new issue <https://github.com/cssr-tools/pyopmspe11/issues>`_ in the repository GitHub page (if you are not familiar with this approach, please visit `GitHub Docs Issues <https://docs.github.com/en/issues/tracking-your-work-with-issues>`_).
43
+
#. We will try to answer as soon as possible, but also any user is more than welcome to answer.
44
+
45
+
============
46
+
Seek support
47
+
============
48
+
49
+
#. The preferred approach to seek support is to raise an Issue as described in the previous lines.
50
+
#. We will try to answer as soon as possible, but also any user is more than welcome to answer.
51
+
52
+
- An alternative approach is to send an email to any of the `mantainers <https://github.com/cssr-tools/pyopmspe11/blob/main/pyproject.toml>`_.
@@ -31,27 +39,39 @@ install the Python requirements in a virtual environment with the following comm
31
39
# For contributions/testing/linting, install the dev-requirements
32
40
pip install -r dev-requirements.txt
33
41
42
+
.. tip::
43
+
44
+
Typing **git tag -l** writes all available specific versions.
45
+
34
46
.. note::
35
47
36
-
Regarding the reading of OPM Flow output files (i.e., .EGRID, .INIT, .UNRST), it is possible to use the OPM python library instead of resdata (e.g., it seems the OPM Python library
37
-
is faster than resdata to read large simulation files). For not macOS users, to install the Python OPM package, execute in the terminal **pip install opm**.
38
-
For macOS, see :ref:`macOS`.
48
+
For not macOS users, to install the Python opm package (this is an alternative
49
+
to `resdata <https://github.com/equinor/resdata>`_, both are use to read OPM output files; while resdata is easier to
50
+
install in macOS, opm seems to be faster), execute in the terminal
51
+
52
+
**pip install opm**
53
+
54
+
For not macOS users, to install the dependencies used for the figure's LaTeX formatting, execute
* OPM Flow (https://opm-project.org, Release 2024.04 or current master branches)
64
+
* OPM Flow (https://opm-project.org, Release 2024.10 or current master branches)
45
65
46
66
.. tip::
47
67
48
68
See the `CI.yml <https://github.com/opm/pyopmspe11/blob/main/.github/workflows/CI.yml>`_ script
49
-
for installation of OPM Flow (binary packages) and the pyopmspe11 package in Linux.
69
+
for installation of OPM Flow (binary packages) and the pyopmspe11 package in Ubuntu.
50
70
51
71
Source build in Linux/Windows
52
72
+++++++++++++++++++++++++++++
53
73
If you are a Linux user (including the Windows subsystem for Linux), then you could try to build Flow (after installing the `prerequisites <https://opm-project.org/?page_id=239>`_) from the master branches with mpi support by running
54
-
in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow.):
74
+
in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow):
55
75
56
76
.. code-block:: console
57
77
@@ -132,6 +152,8 @@ package (see the `prerequisites <https://opm-project.org/?page_id=239>`_, which
132
152
133
153
This builds OPM Flow as well as the OPM Python library, and it exports the required PYTHONPATH. Then after execution, deactivate and activate the Python virtual environment.
134
154
135
-
Regarding the resdata Python package, it might not be available depending on the Python version (e.g., it is not found using Python 3.9, but it is installed using Python 3.10).
136
-
Then, it is recommended to use a Python version equal or higher than 3.10; otherwise, remove resdata from the requirements in the `pyproject.toml <https://github.com/opm/pyopmspe11/blob/main/pyproject.toml>`_,
137
-
and when executing **pyopmspe11** always set the flag **-u opm** (resdata is the default package for reading the simulation files, see the :ref:`overview`).
155
+
Regarding the resdata Python package, it might not be available depending on the Python version (e.g., it is not found using Python 3.9, but it is installed using Python 3.10).
156
+
Then, for macOS users, you need to use a Python version equal or higher than 3.10.
157
+
158
+
For macOS, the LaTeX dependency can be installed from https://www.tug.org/mactex/. If after installation you still face an error due to LaTeX
159
+
when executing pyopmspe11, then add the flag **-l 0** to pyopmspe11.
0 commit comments