Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extra links to README and improve description #264

Merged
merged 6 commits into from
Mar 13, 2024
Merged

Add extra links to README and improve description #264

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8a3e53a
Add stable docs link + journal article badge + tweak description
matt-graham Mar 13, 2024
858a548
Remove unused HDF5 file
matt-graham Mar 13, 2024
945e653
Update branch reference in Codecov badge
matt-graham Mar 13, 2024
2853ac0
Ignore HDF5 files by default
matt-graham Mar 13, 2024
ea1c40e
Replace references to master branch with main
matt-graham Mar 13, 2024
5291fda
Change baseline argument for benchmark CI judge function
matt-graham Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I now renamed the branch, so should replace master -> main everywhere. Sorry! 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also want to change master_rank → main_rank?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potentially yes, but it can be done in a separate PR. Also, it'd probably be a technically breaking change, as I think we expose the name to users at

ParticleDA.jl/src/params.jl

Line 6 in 1618055

* `master_rank` : Id of MPI rank that performs serial computations

Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# ParticleDA

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://team-raddish.github.io/ParticleDA.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://team-raddish.github.io/ParticleDA.jl/dev/)
[![Build Status](https://github.com/Team-RADDISH/ParticleDA.jl/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Team-RADDISH/ParticleDA.jl/actions/workflows/ci.yml?query=branch%3Amaster)
[![Coverage](https://codecov.io/gh/Team-RADDISH/ParticleDA.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Team-RADDISH/ParticleDA.jl)
matt-graham marked this conversation as resolved.
Show resolved Hide resolved
[![DOI](https://zenodo.org/badge/232626497.svg)](https://zenodo.org/badge/latestdoi/232626497)
[![DOI:10.5194/gmd-2023-38](https://img.shields.io/badge/Journal_article-10.5194/gmd--2023--38-d4a519.svg)](https://doi.org/10.5194/gmd-2023-38)

`ParticleDA.jl` is a Julia package to run data assimilation with particle filter
distributed using MPI.

`ParticleDA.jl` is a Julia package to perform data assimilation with particle filters,
supporting both thread-based parallelism and distributed processing using MPI.

This project is developed in collaboration with the
[Centre for Advanced Research Computing](https://ucl.ac.uk/arc), University College London.

## Installation

Expand Down
Binary file removed unit_test.h5
View file
Open in desktop
matt-graham marked this conversation as resolved.
Show resolved Hide resolved
Binary file not shown.
Loading