-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Reorg for build test * Revert structure * Update make.jl * Update docs * Update docs * Update docs * Make docs buildable * Update index.md * Update index.md * Update index.md * Reorg logo
- Loading branch information
Showing
12 changed files
with
185 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,114 @@ | ||
| # JutulDarcy.jl - reservoir simulation and porous media flow in Julia | ||
| ````@raw html | ||
| --- | ||
| # https://vitepress.dev/reference/default-theme-home-page | ||
| layout: home | ||
| ```@meta | ||
| CurrentModule = JutulDarcy | ||
| ``` | ||
| hero: | ||
| name: JutulDarcy | ||
| text: Re-thinking reservoir simulation in Julia | ||
| image: | ||
| src: logo.png | ||
| alt: JutulDarcy | ||
| tagline: High-performance porous media and reservoir simulator based on automatic differentiation | ||
| actions: | ||
| - theme: brand | ||
| text: Getting started | ||
| link: /man/intro | ||
| - theme: alt | ||
| text: View on Github | ||
| link: https://github.com/sintefmath/JutulDarcy.jl | ||
| - theme: alt | ||
| text: Run .DATA file | ||
| link: /examples/data_input_file | ||
| ```@meta | ||
| DocTestSetup = quote | ||
| using Jutul; | ||
| using JutulDarcy; | ||
| end | ||
| ``` | ||
| features: | ||
| - icon: 💥 | ||
| title: Physical systems | ||
| details: Immiscible, compositional, geothermal and black-oil flow | ||
| link: /man/basics/systems | ||
| - icon: ⚙️ | ||
| title: Differentiability | ||
| details: Compute sensitivities of parameters with high-performance adjoint method | ||
| link: /examples/intro_sensitivities | ||
| - icon: 🏃 | ||
| title: High performance | ||
| details: Fast execution with support for MPI and thread parallelism | ||
| link: /man/advanced/mpi | ||
| --- | ||
| ```` | ||
|
|
||
| ## What is this? | ||
|
|
||
| Documentation for [JutulDarcy.jl](https://github.com/sintefmath/JutulDarcy.jl). The documentation consists of a mixture of technical documentation, docstrings and examples. The examples are sorted by complexity. We suggest you start with [Gravity segregation example](Gravity segregation example). | ||
| JutulDarcy.jl is a general high-performance purpose porous media simulator toolbox (CO2 sequestration, gas/H2 storage, oil/gas fields) written in [Julia](https://julialang.org/) based on [Jutul.jl](https://github.com/sintefmath/Jutul.jl), developed by the [Applied Computational Science group](https://www.sintef.no/en/digital/departments-new/applied-mathematics/applied-computational-sciences/) at [SINTEF Digital](https://www.sintef.no/en/digital/). | ||
|
|
||
| To generate a folder that contains the examples locally, you can run the following code to create a folder `jutuldarcy_examples` in your current working directory: | ||
| A few highlights: | ||
|
|
||
| - Immiscible, black-oil, compositional, CO2-brine and geothermal systems | ||
| - Fully differentiable through adjoint method | ||
| - High performance, with optional support for compiling MPI parallel binaries | ||
| - Consistent discretizations | ||
| - Industry standard input formats - or make your own model as a script | ||
| - 3D visualization and tools for post-processing of simulation results | ||
|
|
||
| ## Quick start guide | ||
|
|
||
| [Getting started](man/intro) is the main setup guide that includes the basics of installing Julia and creating a Julia environment for `JutulDarcy.jl`, written for users who may not already be familiar with Julia package management. | ||
|
|
||
| If you want to get started quickly: Install [Julia](https://julialang.org/) and add the following packages together | ||
| with a Makie backend library to your environment of choice using Julia's package manager `Pkg`: | ||
|
|
||
| ```julia | ||
| using JutulDarcy | ||
| generate_jutuldarcy_examples() | ||
| using Pkg | ||
| Pkg.add("GLMakie") # Plotting | ||
| Pkg.add("Jutul") # Base package | ||
| Pkg.add("JutulDarcy") # Reservoir simulator | ||
| ``` | ||
|
|
||
| Alternatively, a folder can be specified if you want the examples to be placed outside your present working directory: | ||
| To verify that everything is working, we have a minimal example that runs a industry standard input file and produces interactive plots. Note that interactive plotting requires `GLMakie`, which may not work if you are running Julia over SSH. | ||
|
|
||
| ::: details Show me the code | ||
|
|
||
| ```@example | ||
| using JutulDarcy, GLMakie | ||
| spe9_dir = JutulDarcy.GeoEnergyIO.test_input_file_path("SPE9") | ||
| file_path = joinpath(spe9_dir, "SPE9.DATA") | ||
| case = setup_case_from_data_file(file_path) | ||
| result = simulate_reservoir(case) | ||
| plot_reservoir_simulation_result(case.model, result) | ||
| ``` | ||
| ::: | ||
|
|
||
| To get access to all the examples, you can generate a folder that contains the examples locally, you can run the following code to create a folder `jutuldarcy_examples` in your current working directory: | ||
|
|
||
| ```julia | ||
| using JutulDarcy | ||
| generate_jutuldarcy_examples("/home/username/") | ||
| generate_jutuldarcy_examples() | ||
| ``` | ||
|
|
||
| JutulDarcy builds upon the general features found in [Jutul.jl](https://github.com/sintefmath/Jutul.jl). You may also find it useful to look at the [Jutul.jl documentation](https://sintefmath.github.io/Jutul.jl/dev/). | ||
| These examples can then be run using `include("jutuldarcy_examples/example_name.jl")` or opened in an editor to be run line by line. Alternatively, you can download all examples as [Jupyter Notebooks](https://github.com/sintefmath/JutulDarcy.jl/tree/gh-pages/dev/examples). | ||
|
|
||
| ## Package docstring | ||
| ## Citing JutulDarcy | ||
|
|
||
| ```@docs | ||
| JutulDarcy | ||
| ``` | ||
| If you use JutulDarcy for a scientific publication, please cite [the main paper](https://doi.org/10.3997/2214-4609.202437111) the following way: | ||
|
|
||
| > O. Møyner, (2024). JutulDarcy.jl - a Fully Differentiable High-Performance Reservoir Simulator Based on Automatic Differentiation. ECMOR 2024, [https://doi.org/10.3997/2214-4609.202437111](https://doi.org/10.3997/2214-4609.202437111) | ||
| ## Index | ||
| ```@index | ||
| ::: details Show BibTeX | ||
|
|
||
| ```bibtex | ||
| @article{jutuldarcy_ecmor_2024, | ||
| author = "M{\o}yner, O.", | ||
| title = "JutulDarcy.jl - a Fully Differentiable High-Performance Reservoir Simulator Based on Automatic Differentiation", | ||
| year = "2024", | ||
| volume = "2024", | ||
| number = "1", | ||
| pages = "1-9", | ||
| doi = "https://doi.org/10.3997/2214-4609.202437111", | ||
| publisher = "European Association of Geoscientists \& Engineers", | ||
| issn = "2214-4609", | ||
| } | ||
| ``` | ||
|
|
||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters