Skip to content

Commit e72d6e3

Browse files
committed
adds guidelines for adding new examples from published papers
1 parent 9c89b14 commit e72d6e3

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

examples/papers/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
Examples aimed at reproduction of published results (each folder corresponds to a specific paper), but they can also be browsed as illustrations of various applications and adapted to similar cases.
2-
* `2021_WKBr/` - "Uniform-over-size approximation of the internal fields for scatterers with low refractive-index contrast", [_JQSRT_ **277**, 107965](http://doi.org/10.1016/j.jqsrt.2021.107965).
3-
* `2022_bessel/` - "Vector Bessel beams: General classification and scattering simulations", [_Phys. Rev. A_ **106**, 033508](https://doi.org/10.1103/PhysRevA.106.033508).
2+
* `2021_WKBr/` - "Uniform-over-size approximation of the internal fields for scatterers with low refractive-index contrast", [_JQSRT_ **277**, 107965](http://doi.org/10.1016/j.jqsrt.2021.107965)
3+
* `2022_bessel/` - "Vector Bessel beams: General classification and scattering simulations", [_Phys. Rev. A_ **106**, 033508](https://doi.org/10.1103/PhysRevA.106.033508)
4+
5+
6+
We plan to add more examples and invite ADDA users to contribute (based on their papers, where ADDA is used). The following describes the possible options of for such contributions, but please consider them as guidelines rather than rigid framework. Importantly, any example will benefit the community. In general, examples may have various levels of completeness with respect to the goal of reproducing published figures:
7+
* **full**: contains ready-to-use scripts, which run ADDA, parse data from other methods (if needed), and plot the results (reproducing specific figures in the papers).
8+
* **intermediate**: contains scripts, which were used to run ADDA and potentially parse or post-process the results. The published figures based on these simulations may be provided in vector format, such as SVG or PDF.
9+
* **low**: contains lists of ADDA command lines, raw simulation results (if not too extensive), and published figures in vector format.
10+
11+
For many papers (especially older ones), the figures were produced with manual operation of proprietary software (e.g., Origin). This usually excludes the full option above, but you may still consider adding corresponding project file for reproducibility. Anyway, please include the figures themselves in some open vector format.

0 commit comments

Comments
 (0)