Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.52 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.52 KB
Raw

SinFVM.jl

Finite volume solvers with an emphasis on modelling surface water with the shallow water equations.

Setting up the first time

Setting up the project directly should just be (run from the root of the repository)

julia --project
] instantiate

It is probably a good idea to run all tests first verify everything installed correctly, so from the root of the repository, run

julia --project test/runtests.jl

Examples

We currently have a couple ofexamples for a full simulation scenario, see

  • examples/shallow_water_1d.jl
  • examples/urban.jl
  • examples/terrain.jl

Generating the documentation

Run (note: currently takes a couple of minutes)

julia --project docs/make.jl

To view the generated documentation, it is probably a good idea to install the LiveServer package and view said documentation through that

julia -e 'using LiveServer; serve(dir="docs/build")'

then point your browser to localhost:8000.

License information

Copyright (c) 2024 SINTEF AS

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.