Skip to content

Commit

Permalink
Replaces en-dashes with ASCII dashes in child README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
myurkin committed Nov 25, 2024
1 parent fd69b34 commit 5398e9a
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ General documentation of ADDA:
* `doxy/Doxyfile` - config file for [doxygen](http://www.doxygen.org) to automatically produce code documentation
* `figs/` - sources of images, used in the manual (licensed under CC BY 4.0)
* `gv/` - sources for schemes used in [CodeDesign](https://github.com/adda-team/adda/wiki/CodeDesign), they are processed into svg files using [GraphViz](http://www.graphviz.org/)
* `history` complete history of ADDA development
* `manual.docx` source of the manual in MS Word format
* `manual.pdf` the manual in PDF format
* `history` - complete history of ADDA development
* `manual.docx` - source of the manual in MS Word format
* `manual.pdf` - the manual in PDF format
8 changes: 4 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Various examples of using ADDA. Mostly these are tutorial examples, which illustrate certain features of ADDA and should not consume too much computational time. The only exception is subfolder `papers/`, which additionally aims to reproduce specific published simulations (thus, may require a large cluster). All examples are designed to be run out of the box assuming that compiled binaries are available (either by default compilation or pre-compiled for Windows). Some only run ADDA with proper command lines, others - also plot or post-process the obtained results. See further details inside corresponding folders:
* `bessel/` examples involving excitation by Bessel beams
* `eels/` examples involving excitation by a fast electron (will be added after #155)
* `papers/` examples reproducing published results
* `find_adda.sh` - common script to locate ADDA binaries and set corresponding environmenal variables
* `bessel/` - examples involving excitation by Bessel beams
* `eels/` - examples involving excitation by a fast electron (will be added after #155)
* `papers/` - examples reproducing published results
* `find_adda.sh` - common script to locate ADDA binaries and set corresponding environmental variables
4 changes: 2 additions & 2 deletions examples/papers/2021_WKBr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Most scripts allow manual configuration of the parameters inside them, but can a

* `cluster/` - realistic scripts for working at the compute cluster, require very large simulation time
* `Mie_solution/` - interface for calculation of the exact electric field in a sphere
* `WKBr/` scripts for calculation of the WKBr approximation (of internal field) for a sphere
* `fig15.sh`, `fig16.sh` simplified calculation scripts (wrappers) for the corresponding figures of the paper
* `WKBr/` - scripts for calculation of the WKBr approximation (of internal field) for a sphere
* `fig15.sh`, `fig16.sh` - simplified calculation scripts (wrappers) for the corresponding figures of the paper
* `calc.sh` - main calculation script, contains a lot of descriptive comments
6 changes: 3 additions & 3 deletions input/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Default input (parameter) files needed in some operational modes of ADDA. If using these modes, copy the corresponding files to the execution directory. Most of these files can be modified by user to fit specific needs.

* `alldir_params.dat` parameters of calculation of some integral scattering quantities, incurring integration over the scattering angle
* `avg_params.dat` parameters of averaging over particle orientation
* `scat_params.dat` parameters of grid of scattering angles, at which the scattering fields are calculated
* `alldir_params.dat` - parameters of calculation of some integral scattering quantities, incurring integration over the scattering angle
* `avg_params.dat` - parameters of averaging over particle orientation
* `scat_params.dat` - parameters of grid of scattering angles, at which the scattering fields are calculated
8 changes: 4 additions & 4 deletions sample/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Output files from the sample simulation (without any options on the command line, e.g., `adda`) and a few sample scripts:
* `run000_sphere_g16_m1.5/` sample output directory
* `run000_sphere_g16_m1.5/` - sample output directory
* `log` - log of sample simulation
* `mueller` - sample angle-resolved Mueller matrix
* `CrossSec-Y` - sample cross sections
* `stdout` standard output of a sample simulation
* `test.pbs` sample PBS script for MPI system
* `test.sge` sample SGE script for MPI system
* `stdout` - standard output of a sample simulation
* `test.pbs` - sample PBS script for MPI system
* `test.sge` - sample SGE script for MPI system
6 changes: 3 additions & 3 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Main source of ADDA, including Makefiles and other scripts. C++ and Fortran sour
* `mpi/Makefile` - makefile for MPI version (called from the main makefile)
* `ocl/Makefile` - makefile for OpenCL version (called from the main makefile)
* `seq/Makefile` - makefile for sequential version (called from the main makefile)
* `ADDAmain.c`, `CalculateE.c`, `calculator.c`, `chebyshev.c`, `cmplx.c/h`, `comm.c/h`, `const.h`, `crosssec.c/h`, `debug.c/h`, `fft.c/h`, `function.h`, `GenerateB.c`, `igt_so.c/h`, `interaction.c/h`, `io.c/h`, `iterative.c`, `linalg.c/h`, `make_particle.c`, `matvec.c`, `memory.c/h`, `oclcore.c/h`, `oclmatvec.c`, `os.h`, `param.c/h`, `parbas.h`, `prec_time.c/h`, `Romberg.c/h`, `sinint.c`, `sparse_ops.h`, `timing.c/h`, `types.h`, `vars.c/h` C source and header files of ADDA (see [CodeDesign](https://github.com/adda-team/adda/wiki/CodeDesign))
* `Makefile` main makefile
* `ADDAmain.c`, `CalculateE.c`, `calculator.c`, `chebyshev.c`, `cmplx.c/h`, `comm.c/h`, `const.h`, `crosssec.c/h`, `debug.c/h`, `fft.c/h`, `function.h`, `GenerateB.c`, `igt_so.c/h`, `interaction.c/h`, `io.c/h`, `iterative.c`, `linalg.c/h`, `make_particle.c`, `matvec.c`, `memory.c/h`, `oclcore.c/h`, `oclmatvec.c`, `os.h`, `param.c/h`, `parbas.h`, `prec_time.c/h`, `Romberg.c/h`, `sinint.c`, `sparse_ops.h`, `timing.c/h`, `types.h`, `vars.c/h` - C source and header files of ADDA (see [CodeDesign](https://github.com/adda-team/adda/wiki/CodeDesign))
* `Makefile` - main makefile
* `common.mk` - common part of child makefiles, including all compilation directives
* `iw_compile.bat` - batch script to compile ADDA with Intel compilers on Windows
* `mt19937ar.c/h` source and header files for Mersenne twister random generator
* `mt19937ar.c/h` - source and header files for Mersenne twister random generator
* `oclkernels.cl` - OpenCL kernels
* `somnec.c/h` - source and header files for computation of Sommerfeld integrals (based on the NEC2C package)
* `somnec_test.c` - a standalone routine to test the calculation of Sommerfeld integrals
Expand Down

0 comments on commit 5398e9a

Please sign in to comment.