Skip to content

Repository files navigation

TrixiData.jl

Docs-stable Docs-dev Build Status Coveralls Codecov Aqua QA License: MIT

TrixiData.jl distributes data files - meshes for now - used by packages of the Trixi Framework, in particular in tests, examples, and documentation.

The data are shipped as lazy Julia artifacts: nothing is downloaded when TrixiData.jl is installed. Instead, a data set is downloaded the first time it is requested and is cached in the Julia depot afterwards, so that it is downloaded only once per machine - even if several packages use it.

Usage

Every data set is made available by a function returning the path to the corresponding file on disk:

julia> using TrixiData

julia> mesh_file = mesh_tandem_spheres_hex_p2()
"/home/user/.julia/artifacts/0123456789abcdef0123456789abcdef01234567/TandemSpheresHexMesh1P2_fixed.inp"

The file lives in the read-only artifact store of the Julia depot. If you need to modify it, copy it to a writable location first.

Licenses

The source code of TrixiData.jl is licensed under the MIT license (see LICENSE.md).

The data files distributed via TrixiData.jl are not covered by that license. Each data set keeps the license of its original source. The origin (including a DOI, if available) and the license of a data set are documented in the docstring of the function providing access to it. Please check the docstring and cite the original source when you use a data set.

Authors and citation

TrixiData.jl is maintained by the authors of Trixi.jl. The data files have their own authors. If you use a data set in your own research, please cite the original source given in the docstring of the corresponding access function.

About

Meshes and more for Trixi.jl

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages