https://github.com/termi-official/thunderbolt.jl
A modular shared-memory high-performance framework for multiscale cardiac multiphysics simulations.
https://github.com/termi-official/thunderbolt.jl
cardiac-dynamics computational-cardiology electromechanics electrophysiology fsi hpc multiphysics-simulation scientific-software
Last synced: 4 months ago
JSON representation
A modular shared-memory high-performance framework for multiscale cardiac multiphysics simulations.
- Host: GitHub
- URL: https://github.com/termi-official/thunderbolt.jl
- Owner: termi-official
- License: mit
- Created: 2021-04-08T23:10:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-17T23:36:25.000Z (4 months ago)
- Last Synced: 2025-01-18T00:19:53.079Z (4 months ago)
- Topics: cardiac-dynamics, computational-cardiology, electromechanics, electrophysiology, fsi, hpc, multiphysics-simulation, scientific-software
- Language: Julia
- Homepage:
- Size: 8.41 MB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 73
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A modular shared-memory high-performance framework for multiscale cardiac multiphysics.
[](https://termi-official.github.io/Thunderbolt.jl/dev)
> [!WARNING]
> This package is under heavy development. Expect regular breaking changes
> for now. If you are interested in joining development, then either comment
> an issue you are interested or directly reach out to me via julialang.zulipchat.com, mail or
> julialang.slack.com. Alternatively open a [GitHub discussion](https://github.com/termi-official/Thunderbolt.jl/discussions) if you have something
> specific in mind.
## Questions
If you have questions about Thunderbolt it is suggested to use the [#Thunderbolt.jl stream on Zulip](https://julialang.zulipchat.com/#narrow/stream/413315-Thunderbolt.2Ejl).
If you encounter what you think is a bug please report it. A CONTRIBUTING.md will be provided soon with more information.
## Installation
To use Thunderbolt you first need to install Julia, see for details.
Installing Thunderbolt can then be done from the Pkg REPL; press `]` at the `julia>` promp to
enter `pkg>` mode:
```
pkg> add Ferrite#b6976d3, https://github.com/termi-official/Thunderbolt.jl#main
```
> [!NOTE]
> The package is under codevelopment with Ferrite.jl, which is why you will need the currently (unreleased)
> 1.0 version of Ferrite.jl and the (unregistered) Thunderbolt.jl package. Please use [these Ferrite.jl docs](https://ferrite-fem.github.io/Ferrite.jl/dev/)
> for Ferrite specific questions.
This will install Thunderbolt and all necessary dependencies. Press backspace to get back to the
`julia>` prompt. (See the [documentation for Pkg](https://pkgdocs.julialang.org/), Julia's
package manager, for more help regarding package installation and project management.)
Finally, to load Thunderbolt, use
```julia
using Thunderbolt
```
You are now all set to start using Thunderbolt!
## Accessing the Documentation Offline
To build the docs you first need to install Julia, see for details.
Then you need to install the packages. To accomplish this you first start a julia shell in the
docs fonder and open the Pkg REPL; i.e. press `]` at the `julia>` promp to
enter `pkg>` mode. Then you [activate and instantiate](https://pkgdocs.julialang.org/v1/environments/#Using-someone-else's-project) via
```
(@v1.9) pkg> activate .
(docs) pkg> instantiate
```
This has to be done only once. Now you can use the provided liveserver to build and open the docs via
```
$ julia --project=. liveserver.jl
```
Now you can view the documentation at https://localhost:8000 . All further information will be provided there.
## Community Standards
Please keep in mind that we are part of the Julia community and adhere to the [Julia Community Standards](https://julialang.org/community/standards/).
## Acknowledgement
This framework is primarily developed at the [chair of continuum mechanics at Ruhr-University Bochum under Prof. Dr.-Ing. Daniel Balzani](https://www.lkm.ruhr-uni-bochum.de/).