annotate README.md @ 637:4a81812150f4 feature/volume_and_boundary_operators

Change qudrature closure from tuple of reals to tuple of Stencils. Also remove parametrization of stencil width in D2 since this was illformed for the 2nd order case.
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Sun, 03 Jan 2021 18:15:14 +0100
parents 76aa1486124a
children 48a61e085e60
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
333
01b851161018 Start converting to one package by moving all the files to their correct location
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 # Sbplib
349
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
2
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
3 ## Running tests
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
4 To run all tests simply run
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
5 ```
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
6 (@v1.5) pkg> activate .
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
7 (Sbplib) pkg> test
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
8 ```
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
9
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
10 If you want to run tests from a specific file in `test/`, you can do
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
11 ```
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
12 julia> using Pkg
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
13 julia> Pkg.test(test_args=["testLazyTensors"])
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
14 ```
76aa1486124a Add some info about running tests in the readme
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
15 This works by using the `@includetests` macro from the [TestSetExtensions](https://github.com/ssfrr/TestSetExtensions.jl) package. For more information, see their documentation.