Skip to content

Commit

Permalink
build based on cf10579
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 19, 2023
1 parent c417a15 commit 41c38be
Show file tree
Hide file tree
Showing 33 changed files with 169 additions and 60 deletions.
2 changes: 1 addition & 1 deletion dev/about/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
doi = {10.1190/geo2018-0174.1},
URL = {https://doi.org/10.1190/geo2018-0174.1},
eprint = {https://doi.org/10.1190/geo2018-0174.1}
}</code></pre><p>Also visit the Devito homepage at <a href="https://www.devitoproject.org/publications">https://www.devitoproject.org/publications</a> for more information and references. If you need to cite a specific version of JUDI, you can find our citeable archives on <a href="https://doi.org/10.5281/zenodo.3878711">Zenodo</a>.</p><h2 id="Contribution-and-community"><a class="docs-heading-anchor" href="#Contribution-and-community">Contribution and community</a><a id="Contribution-and-community-1"></a><a class="docs-heading-anchor-permalink" href="#Contribution-and-community" title="Permalink"></a></h2><p>We gladly welcome and encorage contributions from the community to improve our software and its usability. Feel free to:</p><ul><li>Open <a href="https://github.com/slimgroup/JUDI.jl/issues">issues</a> for bugs</li><li>Start <a href="https://github.com/slimgroup/JUDI.jl/discussions">discussions</a> to interat with the developper and ask any questions</li><li>Open <a href="https://github.com/slimgroup/JUDI.jl/pulls">PR</a> for bug fixes and improvements</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../installation/">Installation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 19 September 2023 02:30">Tuesday 19 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre><p>Also visit the Devito homepage at <a href="https://www.devitoproject.org/publications">https://www.devitoproject.org/publications</a> for more information and references. If you need to cite a specific version of JUDI, you can find our citeable archives on <a href="https://doi.org/10.5281/zenodo.3878711">Zenodo</a>.</p><h2 id="Contribution-and-community"><a class="docs-heading-anchor" href="#Contribution-and-community">Contribution and community</a><a id="Contribution-and-community-1"></a><a class="docs-heading-anchor-permalink" href="#Contribution-and-community" title="Permalink"></a></h2><p>We gladly welcome and encorage contributions from the community to improve our software and its usability. Feel free to:</p><ul><li>Open <a href="https://github.com/slimgroup/JUDI.jl/issues">issues</a> for bugs</li><li>Start <a href="https://github.com/slimgroup/JUDI.jl/discussions">discussions</a> to interat with the developper and ask any questions</li><li>Open <a href="https://github.com/slimgroup/JUDI.jl/pulls">PR</a> for bug fixes and improvements</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../installation/">Installation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Sunday 19 November 2023 03:37">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
8 changes: 4 additions & 4 deletions dev/abstract_vectors/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
seis_block = segy_read(&quot;test_file.segy&quot;)
dobs = judiVector(seis_block; segy_depth_key=&quot;RecGroupElevation&quot;)</code></pre><p>(4) Construct out-of-core data vector from <code>SegyIO.SeisCon</code> object (for large SEG-Y files):</p><pre><code class="language-none">using SegyIO
seis_container = segy_scan(&quot;/path/to/data/directory&quot;,&quot;filenames&quot;,[&quot;GroupX&quot;,&quot;GroupY&quot;,&quot;RecGroupElevation&quot;,&quot;SourceDepth&quot;,&quot;dt&quot;])
dobs = judiVector(seis_container; segy_depth_key=&quot;RecGroupElevation&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/slimgroup/JUDI.jl/blob/83752f147e175608d98b2ffe2d4778d58281c1f1/src/TimeModeling/Types/judiVector.jl#L25-L74">source</a></section></article><p><strong>Access fields (in-core data containers):</strong></p><pre><code class="language-julia"># Access i-th shot record
dobs = judiVector(seis_container; segy_depth_key=&quot;RecGroupElevation&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/slimgroup/JUDI.jl/blob/cf1057925f216b835c54d61cfb083ffa871b2b82/src/TimeModeling/Types/judiVector.jl#L25-L74">source</a></section></article><p><strong>Access fields (in-core data containers):</strong></p><pre><code class="language-julia"># Access i-th shot record
x.data[i]

# Extract judiVector for i-th shot
Expand Down Expand Up @@ -42,7 +42,7 @@
y = x * α

# Concatenate
y = vcat(x, x)</code></pre><h2 id="judiWavefield"><a class="docs-heading-anchor" href="#judiWavefield">judiWavefield</a><a id="judiWavefield-1"></a><a class="docs-heading-anchor-permalink" href="#judiWavefield" title="Permalink"></a></h2><p>Abstract vector class for wavefields. </p><p><strong>Construction:</strong></p><article class="docstring"><header><a class="docstring-binding" id="JUDI.judiWavefield" href="#JUDI.judiWavefield"><code>JUDI.judiWavefield</code></a> — <span class="docstring-category">Type</span></header><section><div><p>judiWavefield nsrc::Integer dt::AbstractFloat data</p><p>Abstract vector for seismic wavefields.</p><p><strong>Constructors</strong></p><p>Construct wavefield vector from an info structure, a cell array of wavefields and the computational <br/>time step dt:</p><pre><code class="language-none">judiWavefield(nsrc, dt, data)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/slimgroup/JUDI.jl/blob/83752f147e175608d98b2ffe2d4778d58281c1f1/src/TimeModeling/Types/judiWavefield.jl#L22-L39">source</a></section></article><p><strong>Access fields:</strong></p><pre><code class="language-julia"># Access wavefield from i-th shot location
y = vcat(x, x)</code></pre><h2 id="judiWavefield"><a class="docs-heading-anchor" href="#judiWavefield">judiWavefield</a><a id="judiWavefield-1"></a><a class="docs-heading-anchor-permalink" href="#judiWavefield" title="Permalink"></a></h2><p>Abstract vector class for wavefields. </p><p><strong>Construction:</strong></p><article class="docstring"><header><a class="docstring-binding" id="JUDI.judiWavefield" href="#JUDI.judiWavefield"><code>JUDI.judiWavefield</code></a> — <span class="docstring-category">Type</span></header><section><div><p>judiWavefield nsrc::Integer dt::AbstractFloat data</p><p>Abstract vector for seismic wavefields.</p><p><strong>Constructors</strong></p><p>Construct wavefield vector from an info structure, a cell array of wavefields and the computational <br/>time step dt:</p><pre><code class="language-none">judiWavefield(nsrc, dt, data)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/slimgroup/JUDI.jl/blob/cf1057925f216b835c54d61cfb083ffa871b2b82/src/TimeModeling/Types/judiWavefield.jl#L22-L39">source</a></section></article><p><strong>Access fields:</strong></p><pre><code class="language-julia"># Access wavefield from i-th shot location
u.data[i]</code></pre><p><strong>Operations:</strong></p><p>Supports some basic arithmetric operations:</p><pre><code class="language-julia"># Size
size(u)

Expand Down Expand Up @@ -70,5 +70,5 @@
# Info structure
rhs.info</code></pre><h2 id="judiWeights"><a class="docs-heading-anchor" href="#judiWeights">judiWeights</a><a id="judiWeights-1"></a><a class="docs-heading-anchor-permalink" href="#judiWeights" title="Permalink"></a></h2><p>Abstract vector class for extended source weights. The weights for each shot location have the dimensions of the model (namely <code>model.n</code>).</p><p><strong>Construction:</strong></p><article class="docstring"><header><a class="docstring-binding" id="JUDI.judiWeights-Union{Tuple{Array{T, N}}, Tuple{N}, Tuple{T}} where {T&lt;:Real, N}" href="#JUDI.judiWeights-Union{Tuple{Array{T, N}}, Tuple{N}, Tuple{T}} where {T&lt;:Real, N}"><code>JUDI.judiWeights</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">judiWeights
nsrc
weights</code></pre><p>Abstract vector for weighting an extended source, which is injected at every grid point, as weighted by this vector. Constructors ============ Construct vector cell array of weights. The <code>weights</code> keyword<br/>can also be a single (non-cell) array, in which case the weights are the same for all source positions: judiWeights(weights; nsrc=1)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/slimgroup/JUDI.jl/blob/83752f147e175608d98b2ffe2d4778d58281c1f1/src/TimeModeling/Types/judiWeights.jl#L27-L37">source</a></section></article><p><strong>Parameters:</strong></p><ul><li><code>weights</code>: Cell array with one cell per shot location. Each cell contains a 2D/3D Julia array with the weights for the spatially extended source. Alternatively: pass a single Julia array which will be used for all source locations.</li></ul><p><strong>Access fields:</strong></p><pre><code class="language-julia"># Access weights of i-th shot locatoin
w.weights[i]</code></pre><p><strong>Operations:</strong></p><p>Supports the same arithmetric operations as a <code>judiVector</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../basics/">« Getting Started</a><a class="docs-footer-nextpage" href="../data_structures/">Data Structures »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 19 September 2023 02:30">Tuesday 19 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
weights</code></pre><p>Abstract vector for weighting an extended source, which is injected at every grid point, as weighted by this vector. Constructors ============ Construct vector cell array of weights. The <code>weights</code> keyword<br/>can also be a single (non-cell) array, in which case the weights are the same for all source positions: judiWeights(weights; nsrc=1)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/slimgroup/JUDI.jl/blob/cf1057925f216b835c54d61cfb083ffa871b2b82/src/TimeModeling/Types/judiWeights.jl#L27-L37">source</a></section></article><p><strong>Parameters:</strong></p><ul><li><code>weights</code>: Cell array with one cell per shot location. Each cell contains a 2D/3D Julia array with the weights for the spatially extended source. Alternatively: pass a single Julia array which will be used for all source locations.</li></ul><p><strong>Access fields:</strong></p><pre><code class="language-julia"># Access weights of i-th shot locatoin
w.weights[i]</code></pre><p><strong>Operations:</strong></p><p>Supports the same arithmetric operations as a <code>judiVector</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../basics/">« Getting Started</a><a class="docs-footer-nextpage" href="../data_structures/">Data Structures »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Sunday 19 November 2023 03:37">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/basics/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,4 +320,4 @@
for j=1:nsrc
J.options.frequencies[j] = select_frequencies(q_dist; fmin=0.003, fmax=0.04, nf=nfreq)
end</code></pre><p>Once the <code>options.frequencies</code> field is set, on-the-fly DFTs are used for both born modeling and RTM. To save computational cost, we can limit the number of DFTs that are performed. Rather than computing the DFT at every time step, we can define a subsampling factor as follows:</p><pre><code class="language-julia"># Compute DFT every 4 time steps
J.options.dft_subsampling_factor=4</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../installation/">« Installation</a><a class="docs-footer-nextpage" href="../abstract_vectors/">Abstract vectors »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 19 September 2023 02:30">Tuesday 19 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
J.options.dft_subsampling_factor=4</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../installation/">« Installation</a><a class="docs-footer-nextpage" href="../abstract_vectors/">Abstract vectors »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Sunday 19 November 2023 03:37">Sunday 19 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 41c38be

Please sign in to comment.