Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hochunlin authored Nov 7, 2023
1 parent 5aa32ce commit 2a1f10f
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,6 @@ To install MESTI.jl, open Julia REPL and type:
import Pkg; Pkg.add("MESTI")
```

After installing MESTI.jl, you may also install other necessary packages which you will utilize in the examples by running <code>[install_packages.jl](./mumps/install_packages.jl)</code>

## Usage Summary

The function [<code>mesti(syst, B, C, D)</code>](./src/mesti_main.m) provides the most flexibility. Structure <code>syst</code> specifies the polarization to use, permittivity profile, boundary conditions in *x* and *y*, which side(s) to put PML with what parameters, the wavelength, and the discretization grid size. Any list of input source profiles can be specified with matrix <code>B</code>, each column of which specifies one source profile **b**(**r**). Any list of output projection profiles can be specified with matrix <code>C</code>. Matrix <code>D</code> is optional (treated as zero when not specified) and subtracts the baseline contribution; see [this paper](https://doi.org/10.1038/s43588-022-00370-6) for details.
Expand All @@ -92,7 +90,7 @@ For example, typing <code>? mesti2s</code> in Julia brings up the documentation

## Acknowledgment

We thank [William Sweeney](https://github.com/wrs28) for granting us permission to integrate his MUMPS-julia interface, [MUMPS3.jl](https://github.com/wrs28/MUMPS3.jl/tree/5.3.3-update), into thia package. The files bearing the mumps3 prefix in the [src](./src) directory have been adopted from the MUMPS3.jl.
We thank [William Sweeney](https://github.com/wrs28) for granting us permission to integrate his MUMPS-julia interface, [MUMPS3.jl](https://github.com/wrs28/MUMPS3.jl/tree/5.3.3-update), into this package. The files bearing the mumps3 prefix in the [src](./src) directory have been adopted from the MUMPS3.jl.

## Reference & Credit

Expand Down

0 comments on commit 2a1f10f

Please sign in to comment.