diff --git a/.codecov.yaml b/.codecov.yaml new file mode 100644 index 00000000..6aa5b2cd --- /dev/null +++ b/.codecov.yaml @@ -0,0 +1,10 @@ +coverage: + status: + patch: + default: + informational: true + project: + default: + informational: true + changes: false +comment: false diff --git a/.github/workflows/blank.yml b/.github/workflows/blank.yml index 8a48b4b3..6bdda191 100644 --- a/.github/workflows/blank.yml +++ b/.github/workflows/blank.yml @@ -41,3 +41,8 @@ jobs: ${{ runner.os }}- - uses: julia-actions/julia-buildpkg@latest - uses: julia-actions/julia-runtest@latest + - uses: julia-actions/julia-processcoverage@v1 + - uses: codecov/codecov-action@v4 + with: + token: ${{ secrets.CODECOV_TOKEN }} + fail_ci_if_error: false # or true if you want CI to fail when Codecov fails diff --git a/README.md b/README.md index 9d3cfa98..026a56a2 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,12 @@ [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliageodynamics.github.io/GeophysicalModelGenerator.jl/dev) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliageodynamics.github.io/GeophysicalModelGenerator.jl/dev/) [![Build Status](https://github.com/JuliaGeodynamics/GeophysicalModelGenerator.jl/workflows/CI/badge.svg)](https://github.com/JuliaGeodynamics/GeophysicalModelGenerator.jl/actions) +[![codecov](https://codecov.io/gh/JuliaGeodynamics/GeophysicalModelGenerator.jl/graph/badge.svg?token=2gEdE0nfSh)](https://codecov.io/gh/JuliaGeodynamics/GeophysicalModelGenerator.jl) [![DOI](https://zenodo.org/badge/366377223.svg)](https://zenodo.org/doi/10.5281/zenodo.8074345)

GeophysicalModelGenerator.jl

-Creating consistent 3D images of geophysical and geological datasets and turning that into an input model for geodynamic simulations is often challenging. The aim of this package is to help with this, by providing a number of routines to easily import data and create a consistent 3D visualisation from it in the VTK-toolkit format, which can for example be viewed with [Paraview](https://www.paraview.org). In addition, we provide a range of tools that helps to generate input models to perform geodynamic simulations and import the results of such simulations back into julia. +Creating consistent 3D images of geophysical and geological datasets and turning that into an input model for geodynamic simulations is often challenging. The aim of this package is to help with this, by providing a number of routines to easily import data and create a consistent 3D visualisation from it in the VTK-toolkit format, which can for example be viewed with [Paraview](https://www.paraview.org). In addition, we provide a range of tools that helps to generate input models to perform geodynamic simulations and import the results of such simulations back into julia. ![README_img](./docs/src/assets/img/Readme_pic.png) ### Contents @@ -31,14 +32,14 @@ Some of the key features are: - Grab screenshots of cross-sections or maps in published papers and view them in 3D (together with other data). - Create a consistent overview that includes all available data of a certain region. - Create initial model setups for the 3D geodynamic code [LaMEM](https://bitbucket.org/bkaus/lamem/src/master/). -- Import LaMEM timesteps. +- Import LaMEM timesteps. All data is transformed into either a `GeoData` or a `UTMData` structure which contains info about `longitude/latitude/depth`, `ew/ns/depth` coordinates along with an arbitrary number of scalar/vector datasets, respectively. All data can be exported to Paraview with the `Write_Paraview` routine, which transfers the data to a `ParaviewData` structure (that contains Cartesian Earth-Centered-Earth-Fixed (ECEF) `x/y/z` coordinates, used for plotting) - -## Usage + +## Usage The best way to learn how to use this is to install the package (see below) and look at the tutorials in the [manual](https://juliageodynamics.github.io/GeophysicalModelGenerator.jl/dev/). -## Installation +## Installation First, you need to install julia on your machine. We recommend to use the binaries from [https://julialang.org](https://julialang.org). Next, start julia and switch to the julia package manager using `]`, after which you can add the package. ```julia @@ -64,7 +65,7 @@ We rely on a number of additional packages, which are all automatically installe ## Visualising Alpine data -We have used this package to interpret various data sets of the Alps (mostly openly available, sometimes derived from published papers). You can download the resulting paraview files here (using the `*.vts` format), where we also included the julia scripts to do the work (some of which are also described in more detail in the tutorials). Just unzip the files and open the corresponding `*.vts` in Paraview. +We have used this package to interpret various data sets of the Alps (mostly openly available, sometimes derived from published papers). You can download the resulting paraview files here (using the `*.vts` format), where we also included the julia scripts to do the work (some of which are also described in more detail in the tutorials). Just unzip the files and open the corresponding `*.vts` in Paraview. [https://seafile.rlp.net/d/22b0fb85550240758552/](https://seafile.rlp.net/d/22b0fb85550240758552/) @@ -73,7 +74,7 @@ If you want your data be included here as well, give us an email (or even better You are very welcome to request new features and point out bugs by opening an issue. You can also help by adding features and creating a pull request. ## Development roadmap -In the pipeline: +In the pipeline: - Create an interactive tool to visualize data and to interpret datasets, based on [GLMakie](https://docs.makie.org/stable/) ## Funding