-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for installation (#317)
* implement * Revert "implement" This reverts commit 171505a. * some improvements to the documentation * some more fixes * add install documentation * add paraview * implement suggestions * update * update * remove file * fix --------- Co-authored-by: Erik Faulhaber <[email protected]>
- Loading branch information
1 parent
d402b54
commit da759dd
Showing
1 changed file
with
40 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,40 @@ | ||
# Installation | ||
# Installation | ||
|
||
## Setting up Julia | ||
If you have not yet installed Julia, please [follow the instructions for your | ||
operating system](https://julialang.org/downloads/platform/). TrixiParticles.jl works | ||
with Julia v1.9 and newer. We recommend using the latest stable release of Julia. | ||
|
||
## Installation for users | ||
|
||
|
||
## [Installation for developers](@id for-developers) | ||
If you plan on editing TrixiParticles.jl itself, you can download TrixiParticles.jl to a local folder and use the | ||
code from the cloned directory: | ||
```bash | ||
git clone [email protected]:trixi-framework/TrixiParticles.jl.git | ||
cd TrixiParticles.jl | ||
mkdir run | ||
julia --project=run -e 'using Pkg; Pkg.develop(PackageSpec(path=".."))' # Install locally | ||
julia --project=run -e 'using Pkg; Pkg.add("OrdinaryDiffEq")' # Add TrixiParticles.jl to `run` project | ||
``` | ||
|
||
If you installed TrixiParticles.jl this way, you always have to start Julia with the `--project` | ||
flag set to your `run` directory, e.g., | ||
```bash | ||
julia --project=run | ||
``` | ||
from the TrixiParticles.jl root directory. | ||
|
||
The advantage of using a separate `run` directory is that you can also add other | ||
related packages (e.g., OrdinaryDiffEq.jl, see above) to the project in the `run` folder | ||
and always have a reproducible environment at hand to share with others. | ||
|
||
## Optional Software/Packages | ||
- [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) -- a Julia package of ordinary differential equation solvers that is used in the examples | ||
- [Plots.jl](https://github.com/JuliaPlots/Plots.jl) -- Julia Plotting library that is used in some examples | ||
- [PythonPlot.jl](https://github.com/JuliaPy/PythonPlot.jl) -- Plotting library that can be used instead of Plots.jl | ||
- [ParaView](https://www.paraview.org/) -- Software that can be used for visualization of results | ||
|
||
## Common issues | ||
|