Merge pull request #195 from underworldcode/2.10-pre_release

2.10 pre release

Author: julesghub

.gitattributes

@@ -1,4 +1 @@
-examples/* linguist-vendored
-benchmarks/* linguist-vendored
-tutorials/* linguist-vendored
 docs/* linguist-vendored

.github/workflows/test.yml

@@ -3,15 +3,18 @@ name: tests
 on: [push]
 
 jobs:
-  test:
+  test_in_UW_Container:
     runs-on: ubuntu-latest
+    container:
+      image: underworldcode/underworld2:2.10.0b
+      options: --user root
     steps:
-      - uses: actions/checkout@v2
-      - name: Build the stack
-        run: docker-compose up -d
-      - name: Test
-        run: docker exec -i UWGeodynamics-dev /bin/bash 
-      - name: Install UWGeodynamics
-        run: cd workspace & pip install -e .
-      - name: Run tests
-        run: pip install pytest & pytest -v
+      - name: Test in UW Container
+        run: |
+          cd /home/jovyan/workspace
+          git clone -b ${GITHUB_REF##*/} https://github.com/underworldcode/UWGeodynamics.git UWGeodynamics
+          cd UWGeodynamics
+          # git checkout development
+          pip install -e .
+          pip install pytest
+          python -m pytest -vvv

.readthedocs.yml

@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/readthedocs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/readthedocs/requirements.txt

.zenodo.json

@@ -0,0 +1,73 @@
+{
+    "creators": [
+        {
+            "name": "Romain Beucher",
+            "affiliation": "School of Earth Science, The University of Melbourne",
+            "orcid": "0000-0003-3891-5444"
+        },
+        {
+            "name": "Louis Moresi",
+            "affiliation": "Research School of Earth Sciences, The Australian National University; School of Earth Science, The University of Melbourne",
+            "orcid": "0000-0003-3685-174X"
+        },
+        {
+            "name": "Julian Giordani",
+            "affiliation": "School of Earth Science, The University of Melbourne",
+            "orcid": "0000-0003-4515-9296"
+        },
+        {
+            "name": "John Mansour",
+            "affiliation": "Monash eResearch Centre, Monash University",
+            "orcid": "0000-0001-5865-1664"
+        },
+        {
+            "name": "Dan Sandiford",
+            "affiliation": "University of Tasmania",
+            "orcid": "0000-0002-2207-6837"
+        },
+        {
+            "name": "Rebecca Farrington",
+            "affiliation": "School of Earth Science, The University of Melbourne",
+            "orcid": "0000-0002-2594-6965"
+        },
+        {
+            "name": "Luke Mondy",
+            "affiliation": "School of Geosciences, Earthbyte Research Group, The University of Sydney",
+            "orcid": "0000-0001-7779-509X"
+        },
+        {
+            "name": "Claire Mallard", 
+            "affiliation": "School of Geosciences, Earthbyte Research Group, The University of Sydney",
+            "orcid": "0000-0003-2595-2414"
+        },      
+        {
+            "name": "Patrice Rey",
+            "affiliation": "School of Geosciences, Earthbyte Research Group, The University of Sydney",
+            "orcid": "0000-0002-1767-8593"
+        },      
+        {
+            "name": "Guillaume Duclaux",
+            "affiliation": "Laboratoire Géoazur, Université Nice Sophia Antipolis, Nice",
+            "orcid": "0000-0002-9512-7252"
+        },      
+        {
+            "name": "owen kaluza",
+            "affiliation": "Monash eResearch Centre, Monash University",
+            "orcid": "0000-0001-6303-5671"
+        },
+        {
+            "name": "Arijit Laik", 
+            "affiliation": "Department of Earth Science, Faculty of Science, Vrije Universiteit",
+            "orcid": "0000-0002-3484-7985"
+        },      
+        {
+            "name": "Sara Morón",
+            "affiliation": "School of Geosciences, Earthbyte Research Group, The University of Sydney",
+            "orcid": "0000-0002-1270-4377"
+        }      
+    ],
+    "license": "lgpl-3.0",
+    "title": "UWGeodynamics: A teaching an research tool for numerical geodynamic modelling",
+    "upload_type": "software",
+    "access_right": "open"
+}

CHANGELOG.txt CHANGELOG.mdCHANGELOG.txt renamed to CHANGELOG.md

@@ -1,3 +1,9 @@
+# Version 2.10
+
+
+- Layer2D which has now been deprecated for a while has been removed
+
+
 # Version 2.9
 
 ### User related changes:

Dockerfile

@@ -1,6 +1,6 @@
-# Stage 1: Inherit from underworldcode/underworld2:2.9.1b and install dependency packages for Badlands
+# Stage 1: Inherit from underworldcode/underworld2:2.10.0b and install dependency packages for Badlands
 ##########
-FROM underworldcode/underworld2:2.9.4b as base_runtime
+FROM underworldcode/underworld2:2.10.0b as base_runtime
 MAINTAINER https://github.com/underworldcode/
 # install runtime requirements
 USER root
@@ -27,7 +27,10 @@ RUN PYTHONPATH= /usr/bin/pip3 install --no-cache-dir setuptools scons
 # setup further virtualenv to avoid double copying back previous packages (h5py,mpi4py,etc)
 RUN /usr/bin/python3 -m virtualenv --python=/usr/bin/python3 ${VIRTUAL_ENV}
 # Compile and install the latest UWGeodynamics & Badlands
-RUN pip3 install -U UWGeodynamics badlands
+WORKDIR /tmp
+COPY --chown=jovyan:users . /tmp/UWGeodynamics
+RUN pip3 install -vvv UWGeodynamics/ 
+RUN pip3 install -U badlands
 
 
 # Stage 3: Resultant images

LICENSE.md

@@ -0,0 +1,163 @@
+GNU Lesser General Public License
+=================================
+
+_Version 3, 29 June 2007_  
+_Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+### 0. Additional Definitions
+
+As used herein, “this License” refers to version 3 of the GNU Lesser
+General Public License, and the “GNU GPL” refers to version 3 of the GNU
+General Public License.
+
+“The Library” refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the “Linked
+Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+### 1. Exception to Section 3 of the GNU GPL
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+### 2. Conveying Modified Versions
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+* **a)** under this License, provided that you make a good faith effort to
+ensure that, in the event an Application does not supply the
+function or data, the facility still operates, and performs
+whatever part of its purpose remains meaningful, or
+
+* **b)** under the GNU GPL, with none of the additional permissions of
+this License applicable to that copy.
+
+### 3. Object Code Incorporating Material from Library Header Files
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+* **a)** Give prominent notice with each copy of the object code that the
+Library is used in it and that the Library and its use are
+covered by this License.
+* **b)** Accompany the object code with a copy of the GNU GPL and this license
+document.
+
+### 4. Combined Works
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+* **a)** Give prominent notice with each copy of the Combined Work that
+the Library is used in it and that the Library and its use are
+covered by this License.
+
+* **b)** Accompany the Combined Work with a copy of the GNU GPL and this license
+document.
+
+* **c)** For a Combined Work that displays copyright notices during
+execution, include the copyright notice for the Library among
+these notices, as well as a reference directing the user to the
+copies of the GNU GPL and this license document.
+
+* **d)** Do one of the following:
+    - **0)** Convey the Minimal Corresponding Source under the terms of this
+License, and the Corresponding Application Code in a form
+suitable for, and under terms that permit, the user to
+recombine or relink the Application with a modified version of
+the Linked Version to produce a modified Combined Work, in the
+manner specified by section 6 of the GNU GPL for conveying
+Corresponding Source.
+    - **1)** Use a suitable shared library mechanism for linking with the
+Library.  A suitable mechanism is one that **(a)** uses at run time
+a copy of the Library already present on the user's computer
+system, and **(b)** will operate properly with a modified version
+of the Library that is interface-compatible with the Linked
+Version.
+
+* **e)** Provide Installation Information, but only if you would otherwise
+be required to provide such information under section 6 of the
+GNU GPL, and only to the extent that such information is
+necessary to install and execute a modified version of the
+Combined Work produced by recombining or relinking the
+Application with a modified version of the Linked Version. (If
+you use option **4d0**, the Installation Information must accompany
+the Minimal Corresponding Source and Corresponding Application
+Code. If you use option **4d1**, you must provide the Installation
+Information in the manner specified by section 6 of the GNU GPL
+for conveying Corresponding Source.)
+
+### 5. Combined Libraries
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+* **a)** Accompany the combined library with a copy of the same work based
+on the Library, uncombined with any other library facilities,
+conveyed under the terms of this License.
+* **b)** Give prominent notice with the combined library that part of it
+is a work based on the Library, and explaining where to find the
+accompanying uncombined form of the same work.
+
+### 6. Revised Versions of the GNU Lesser General Public License
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License “or any later version”
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.