update the README

- add some hyperlinks
- small updates to the text/formatting
This commit is contained in:
2021-09-29 10:48:02 -07:00
parent d2c985ed87
commit 306fe57d32

View File

@@ -2,39 +2,62 @@
### Contents ###
This is the fortran source code and GUI of TrimSP Monte-Carlo simulations.
This repository contains the [Fortran] source code and an accompanying
graphical user interface ([GUI]) for TrimSP -
an application for performing [Monte Carlo] simulations of ion implantation.
* This code is specifically tuned to simulate implantation of low energy projectiles in materials.
* The code is maintained by the Low Energy Muons group at PSI.
* The GUI is written in Node.js, JavaScript and Electron.
* The binary (statically linked) from the fortran code is also included.
* RPM and DEB packages are also included
* This code is specifically tuned to simulate implantation of low-energy projectiles in materials.
* The code is maintained by the Low Energy Muons ([LEM]) group at the Paul Scherrer Institute ([PSI]).
* The [GUI] is written in [Node.js], [JavaScript] and [Electron].
* The binary (statically linked) from the [Fortran] code is also included.
* [RPM] and [DEB] packages are also included.
### Supported platforms ###
* Linux
* [Linux]
### Installation ###
###### Fortran code compilation ######
Install gfortran compiler, then:
Install the `gfortran` compiler, then:
cd trimsp/fortran
make
make install
```bash
cd trimsp/fortran
make
make install
```
This will install the `trimspNL` in `/usr/local/bin`, but can be moved to any other directory in your `PATH`.
This will install the `trimspNL` binary in `/usr/local/bin`,
but it can be moved to any other directory in your `PATH`.
###### Running the GUI ######
Install Node.js (nodejs, nodejs-libs and npm), then
Install [Node.js] (`nodejs`, `nodejs-libs` and `npm`),
then run:
cd trimsp
npm install
npm start
```bash
cd trimsp
npm install
npm start
```
You do not need to run `npm install` every time. Next time you can simply run `npm start` only.
Note: you do not need to run `npm install` every time.
Next time you can simply run `npm start` only.
### Contact ###
Zaher Salman <zaher.salman@psi.ch>
[Fortran]: https://fortran-lang.org/
[Node.js]: https://nodejs.org/en/
[JavaScript]: https://www.javascript.com/
[Electron]: https://www.electronjs.org/
[PSI]: https://www.psi.ch/en
[LEM]: https://www.psi.ch/en/low-energy-muons
[RPM]: https://rpm.org/
[DEB]: https://en.wikipedia.org/wiki/Deb_(file_format)
[Linux]: https://en.wikipedia.org/wiki/Linux
[Monte Carlo]: https://en.wikipedia.org/wiki/Monte_Carlo_method
[GUI]: https://en.wikipedia.org/wiki/Graphical_user_interface