# Traceon
Traceon is a general software package used for numerical electron optics. Its main feature is the implementation of the Boundary Element Method (BEM) to quickly calculate the surface charge distribution. The program supports both radial symmetry and general three-dimensional geometries. 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.
The core of Traceon is completely free to use and open source. There is a commerical upgrade with more capabilities. The source code in this repository is distributed under the `MPL 2.0` license.
## Documentation
[Website](https://traceon.org/)
[Examples](https://github.com/leon-vv/Traceon/tree/main/examples)
[API documentation v0.8.0](https://traceon.org/docs/v0.8.0/index.html)
[API documentation v0.7.3](https://traceon.org/docs/v0.7.3/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.7.0). 2024. https://doi.org/10.5281/zenodo.14176070
```
## Installation
Install using the Python package manager:
```
pip install traceon
```
The installation is known to work on Linux, Windows and Mac OS. Please reach out to me if you have any installation problems.
## Validations
To ensure the accuracy of the package, different problems from the literature have been analyzed using this software. See [/validation](https://github.com/leon-vv/Traceon/tree/main/validation) directory for more information. The validations can easily be executed from the command line, for example:
```bash
python3 ./validation/edwards2007.py --help
python3 ./validation/capacitance-sphere.py --help
etc...
```
## License
[MPL 2.0](https://mozilla.org/MPL/2.0/)
## Help! I have a problem!
Don't worry. You can reach me.
[Open an issue](https://github.com/leon-vv/Traceon/issues)
[Send me an email](mailto:leonvanvelzen@protonmail.com)
## Gallery
## Release notes
### v0.8.0
- New plotting module (charge density, equipotential lines)
- Automatic orientation of normal vectors
- Geometry functions for extruding/revolving edges of surfaces
- Tracing of particles other than electrons (charge, mass as input)
- Various bug fixes and improvements
**Breaking changes**:
- Call `P.show()` after `P.plot_mesh()` to show figures
- Normal vectors should be oriented automatically (please check if this works correctly for your geometry)
<br />
### v0.7.0
- Generate structured, high quality meshes using the new parametric mesher (drop GMSH)
- Consistenly use 3D points and geometries throughout codebase
- Add support for Fast Multipole Method (Traceon Pro)
- Add support for Mac OS on x64
- Big improvements to code quality, testing, infrastructure
- Drop dependency on GSL
### v0.6.0:
- New methods to integrate triangle potential and field contribution over a triangle
- Fix 3D convergence issues by more accurately calculating neighbouring triangle interactions
- Fix error calculation in particle tracing
- Introduce logging module to control verbosity of printing
- Clean up unit tests
- Remove higher order (curved) triangle support, in preparation of parametric meshers and improved FFM implementation
### v0.5.0:
- Add preliminary support for magnetostatics
- Improve and generalize mesh class (allow import/export)
- Make consistent use of SI units
### v0.4.0:
- Introduce Fast Multipole Method (FMM) for large 3D problems
- Compute 3D radial expansion coefficients using analytical formulas
- Further speed up computation of 3D radial expansion coefficients
- Big code quality improvement of validation/ files
### v0.3.0:
- Use adaptive integration using GNU Scientific Library (GSL)
- Add support for boundary constraint
- Use [Vedo](https://vedo.embl.es/) for better plotting capabilities
- Use higher order triangle elements for 3D (curved triangles)
- Precompute jacobians/positions for better performance
- First implementation of element splitting based on charges (work in progress)
### v0.2.0:
- Use higher order charge distribution on line elements in radial symmetry
- Use higher order line elements (polynomials) in radial symmetry
- Better integration techniques, especially with regards to the logarithmic singularities
### v0.1.0:
- Uses the powerful [GMSH library](https://gmsh.info/) for meshing
- Solve for surface charge distribution using BEM
- General 3D geometries and radially symmetric geometries
- Dielectrics
- Floating conductors
- Accurate electron tracing using adaptive time steps
- Field/potential calculation by integration over surface charges
- Fast field/potential calculation by radial series expansion
- Superposition of electrostatic fields
Raw data
{
"_id": null,
"home_page": "https://github.com/leon-vv/Traceon",
"name": "traceon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "boundary element method, BEM, electrostatic, electromagnetic, electron microscope, electron, tracing, particle, tracer, electron optics",
"author": "L\u00e9on van Velzen",
"author_email": "leonvanvelzen@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/c9/1555a51fb00b8e73666320cd5d9e57abc0d1a543688d51073e8d1ee85f12/traceon-0.8.0.tar.gz",
"platform": null,
"description": "# Traceon\n\nTraceon is a general software package used for numerical electron optics. Its main feature is the implementation of the Boundary Element Method (BEM) to quickly calculate the surface charge distribution. The program supports both radial symmetry and general three-dimensional geometries. 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.\n\nThe core of Traceon is completely free to use and open source. There is a commerical upgrade with more capabilities. The source code in this repository is distributed under the `MPL 2.0` license.\n\n## Documentation\n\n[Website](https://traceon.org/)\n\n[Examples](https://github.com/leon-vv/Traceon/tree/main/examples)\n\n[API documentation v0.8.0](https://traceon.org/docs/v0.8.0/index.html)\n\n[API documentation v0.7.3](https://traceon.org/docs/v0.7.3/index.html)\n\n[API documentation v0.6.0](https://traceon.org/docs/v0.6.0/index.html)\n\n## Citation\n\nPlease cite the software as follows:\n\n```\nL.B. van Velzen. Traceon software (version 0.7.0). 2024. https://doi.org/10.5281/zenodo.14176070\n```\n\n## Installation\n\nInstall using the Python package manager:\n```\npip install traceon\n```\n\nThe installation is known to work on Linux, Windows and Mac OS. Please reach out to me if you have any installation problems.\n\n## Validations\n\nTo ensure the accuracy of the package, different problems from the literature have been analyzed using this software. See [/validation](https://github.com/leon-vv/Traceon/tree/main/validation) directory for more information. The validations can easily be executed from the command line, for example:\n```bash\npython3 ./validation/edwards2007.py --help\npython3 ./validation/capacitance-sphere.py --help\netc...\n```\n\n## License\n\n[MPL 2.0](https://mozilla.org/MPL/2.0/)\n\n\n## Help! I have a problem!\n\nDon't worry. You can reach me.\n\n[Open an issue](https://github.com/leon-vv/Traceon/issues)\n\n[Send me an email](mailto:leonvanvelzen@protonmail.com)\n\n## Gallery\n\n\n\n\n\n## Release notes\n\n### v0.8.0\n- New plotting module (charge density, equipotential lines)\n- Automatic orientation of normal vectors\n- Geometry functions for extruding/revolving edges of surfaces\n- Tracing of particles other than electrons (charge, mass as input)\n- Various bug fixes and improvements\n\n**Breaking changes**:\n- Call `P.show()` after `P.plot_mesh()` to show figures\n- Normal vectors should be oriented automatically (please check if this works correctly for your geometry)\n<br />\n\n### v0.7.0\n- Generate structured, high quality meshes using the new parametric mesher (drop GMSH)\n- Consistenly use 3D points and geometries throughout codebase\n- Add support for Fast Multipole Method (Traceon Pro)\n- Add support for Mac OS on x64\n- Big improvements to code quality, testing, infrastructure\n- Drop dependency on GSL\n\n### v0.6.0:\n- New methods to integrate triangle potential and field contribution over a triangle\n- Fix 3D convergence issues by more accurately calculating neighbouring triangle interactions\n- Fix error calculation in particle tracing\n- Introduce logging module to control verbosity of printing\n- Clean up unit tests\n- Remove higher order (curved) triangle support, in preparation of parametric meshers and improved FFM implementation\n\n### v0.5.0:\n- Add preliminary support for magnetostatics\n- Improve and generalize mesh class (allow import/export)\n- Make consistent use of SI units\n\n### v0.4.0:\n- Introduce Fast Multipole Method (FMM) for large 3D problems\n- Compute 3D radial expansion coefficients using analytical formulas\n- Further speed up computation of 3D radial expansion coefficients \n- Big code quality improvement of validation/ files\n\n### v0.3.0:\n- Use adaptive integration using GNU Scientific Library (GSL)\n- Add support for boundary constraint\n- Use [Vedo](https://vedo.embl.es/) for better plotting capabilities\n- Use higher order triangle elements for 3D (curved triangles)\n- Precompute jacobians/positions for better performance\n- First implementation of element splitting based on charges (work in progress)\n\n### v0.2.0:\n- Use higher order charge distribution on line elements in radial symmetry\n- Use higher order line elements (polynomials) in radial symmetry\n- Better integration techniques, especially with regards to the logarithmic singularities\n\n### v0.1.0:\n- Uses the powerful [GMSH library](https://gmsh.info/) for meshing\n- Solve for surface charge distribution using BEM\n- General 3D geometries and radially symmetric geometries\n- Dielectrics\n- Floating conductors\n- Accurate electron tracing using adaptive time steps\n- Field/potential calculation by integration over surface charges\n- Fast field/potential calculation by radial series expansion\n- Superposition of electrostatic fields\n\n\n",
"bugtrack_url": null,
"license": "MPL 2.0",
"summary": "Solver and tracer for electrostatic problems",
"version": "0.8.0",
"project_urls": {
"Code": "https://github.com/leon-vv/traceon",
"Documentation": "https://leon.science/traceon",
"Homepage": "https://github.com/leon-vv/Traceon",
"Issues": "https://github.com/leon-vv/traceon/issues"
},
"split_keywords": [
"boundary element method",
" bem",
" electrostatic",
" electromagnetic",
" electron microscope",
" electron",
" tracing",
" particle",
" tracer",
" electron optics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5857176ffbf6bcaf8152e877e7999ac2ff791f25ba0020cae9717ad3bd8f8e8a",
"md5": "b2b982a7d092ee6be94fa74ed5e6365a",
"sha256": "1dde805b0a185504852a59e4dd152dfbbc6e2f16648b0682d02448da059c5446"
},
"downloads": -1,
"filename": "traceon-0.8.0-cp37-abi3-macosx_12_0_x86_64.whl",
"has_sig": false,
"md5_digest": "b2b982a7d092ee6be94fa74ed5e6365a",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 131349,
"upload_time": "2024-12-16T10:43:26",
"upload_time_iso_8601": "2024-12-16T10:43:26.587006Z",
"url": "https://files.pythonhosted.org/packages/58/57/176ffbf6bcaf8152e877e7999ac2ff791f25ba0020cae9717ad3bd8f8e8a/traceon-0.8.0-cp37-abi3-macosx_12_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd8a042192b4eb33cfcb8abd6a6abc773d2468281a06f4d354e75107b5c53d69",
"md5": "34474275c43fb568877d3b4e124c9f23",
"sha256": "dd16ff4d791c3f2d7d6782b55451eda541f56b612f1ebb12fb1571fc49245f1b"
},
"downloads": -1,
"filename": "traceon-0.8.0-cp37-abi3-manylinux_2_31_x86_64.whl",
"has_sig": false,
"md5_digest": "34474275c43fb568877d3b4e124c9f23",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 180360,
"upload_time": "2024-12-16T10:43:29",
"upload_time_iso_8601": "2024-12-16T10:43:29.497551Z",
"url": "https://files.pythonhosted.org/packages/dd/8a/042192b4eb33cfcb8abd6a6abc773d2468281a06f4d354e75107b5c53d69/traceon-0.8.0-cp37-abi3-manylinux_2_31_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2083cd0891c72dfd969f400890af923f1dc99b0fbdd2f4bd898b3accbbaf3e4c",
"md5": "1f011a94f3808c9e37e5662468f22009",
"sha256": "69c753cc3a9e1b34fcb4b348969dd7decc0f5f13c85774713bb0895bf486a5e1"
},
"downloads": -1,
"filename": "traceon-0.8.0-cp37-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "1f011a94f3808c9e37e5662468f22009",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 178212,
"upload_time": "2024-12-16T10:43:30",
"upload_time_iso_8601": "2024-12-16T10:43:30.694577Z",
"url": "https://files.pythonhosted.org/packages/20/83/cd0891c72dfd969f400890af923f1dc99b0fbdd2f4bd898b3accbbaf3e4c/traceon-0.8.0-cp37-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ac91555a51fb00b8e73666320cd5d9e57abc0d1a543688d51073e8d1ee85f12",
"md5": "183ee23173b609942730ea6b32467944",
"sha256": "f106de02ddd431bd2a8a6b875d1f187f84aa4d95d0a3ce778712ec8fd41357a7"
},
"downloads": -1,
"filename": "traceon-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "183ee23173b609942730ea6b32467944",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 88361,
"upload_time": "2024-12-16T10:43:31",
"upload_time_iso_8601": "2024-12-16T10:43:31.766179Z",
"url": "https://files.pythonhosted.org/packages/7a/c9/1555a51fb00b8e73666320cd5d9e57abc0d1a543688d51073e8d1ee85f12/traceon-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 10:43:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "leon-vv",
"github_project": "Traceon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "traceon"
}
JSON
