Skip to content

Commit

Permalink
Update README and docs/
Browse files Browse the repository at this point in the history
  • Loading branch information
leon-vv committed Nov 17, 2024
1 parent 1e05ff6 commit 7cf6eda
Show file tree
Hide file tree
Showing 31 changed files with 4 additions and 12,941 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,16 @@ The core of Traceon is completely free to use and open source. There is a commer

[Examples](https://github.com/leon-vv/Traceon/tree/main/examples)

[API documentation v0.6.0](https://traceon.org/docs/v0.6.0/index.html)

[API documentation v0.5.0](https://traceon.org/docs/v0.5.0/index.html)
[API documentation v0.7.0](https://traceon.org/docs/v0.7.0/index.html)

[API documentation v0.4.0](https://traceon.org/docs/v0.4.0/index.html)

[API documentation v0.3.1](https://traceon.org/docs/v0.3.1/index.html)
[API documentation v0.6.0](https://traceon.org/docs/v0.6.0/index.html)

## Citation

Please cite the software as follows:

```
L.B. van Velzen. Traceon software (version 0.6.0). 2023. https://doi.org/10.5281/zenodo.11528404
L.B. van Velzen. Traceon software (version 0.7.0). 2024. https://doi.org/10.5281/zenodo.14176070
```

## Installation
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h1 class="title">Package <code>traceon</code></h1>
Electron tracing can be done very quickly using accurate radial series interpolation in both geometries.
The electron trajectories obtained can help determine the aberrations of the optical components under study.</p>
<p>If you have any issues using the package, please open an issue on the <a href="https://github.com/leon-vv/Traceon">Traceon Github page</a>.</p>
<p>The software is currently distributed under the <code>AGPLv3</code> license. </p>
<p>The software is currently distributed under the <code>MPL 2.0</code> license. </p>
<h1 id="usage">Usage</h1>
<p>In general, one starts with the <code><a title="traceon.geometry" href="geometry.html">traceon.geometry</a></code> module to create a mesh. For the BEM only the boundary of
electrodes needs to be meshed. So in 2D (radial symmetry) the mesh consists of line elements while in 3D the
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
706 changes: 0 additions & 706 deletions docs/docs/v0.7.0rc1/excitation.html

This file was deleted.

82 changes: 0 additions & 82 deletions docs/docs/v0.7.0rc1/focus.html

This file was deleted.

Loading

0 comments on commit 7cf6eda

Please sign in to comment.