Track Ice Floes using Moderate Resolution Imaging Spectroradiometer (MODIS) data.
See the package's documentation (in development) at https://wilhelmuslab.github.io/IceFloeTracker.jl/
A julia
installation; ensure it is available on the PATH
.
Clone the repository.
$ git clone https://github.com/WilhelmusLab/IceFloeTracker.jl
Now start a Julia session.
$ julia
julia> ]
... to enter package mode.
(@v1.9) pkg> activate IceFloeTracker.jl/
Activating project at `~/IceFloeTracker.jl`
Instantiate the environment and run the tests:
(IceFloeTracker) pkg> instantiate
(IceFloeTracker) pkg> test
There are Jupyter notebooks illustrating the main image processing and tracking functions, in the /notebooks
folder.
See related tools in the IFTPipeline repository, including a Julia Command-line Interface and templates that leverage the Cylc pipeline orchestrator.
Git hooks are used to run common developer tasks on commits (e.g. code formatting, tests, etc.). If you are running git version 2.9 or later run the following from the root of the project to enable git hooks.
git config core.hooksPath ./hooks
To help with passing git hooks, run the formatting script before staging files:
./scripts/format.jl
git add .
git commit -m "some informative message"
git push
Project.toml
@JuliaRegistrator register
in a comment in the commit you wish to use for the release
Draft a new release
Generate release notes
or add a custom descriptionice-floe-tracker-pipeline
repo and update the [compat]
section of the Project.toml
where IceFloeTracker
is a dependency.Note: After the PR for the release is merged, a trigger workflow will force a rebuild of Docker container used in the pipeline.