Skip to content

Commit

Permalink
Update installation instructions (#241)
Browse files Browse the repository at this point in the history 
The package is now in the General registry and does not have to be installed
from the URL.
  • Loading branch information
@giordano
giordano authored May 5, 2023
1 parent 20b6ad6 commit 87c0324
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ParticleDA"
uuid = "61cd1fb4-f4c4-4bc8-80c6-ea5639a6ca2e"
authors = ["Mosè Giordano and Tuomas Koskela and Dan Giles and Matt Graham"]
version = "1.0.0"
version = "1.0.1"

[deps]
HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
Expand Down
10 changes: 3 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@
`ParticleDA.jl` is a Julia package to run data assimilation with particle filter
distributed using MPI.

## Disclaimer

This repository is a work in progress and will be updated frequently. Use at your own risk!

## Installation

To install the package, open the [Julia
To install the latest stable version of the package, open the [Julia
REPL](https://docs.julialang.org/en/v1/stdlib/REPL/), enter the package manager
with `]`, then run the command

```
add https://github.com/Team-RADDISH/ParticleDA.jl.git
add ParticleDA
```

If you plan to develop the package (make changes, submit pull requests, etc), in
the package manager mode run this command

```
dev https://github.com/Team-RADDISH/ParticleDA.jl.git
dev ParticleDA
```

This will automatically clone the repository to your local directory
Expand Down
9 changes: 5 additions & 4 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@ package to perform data assimilation with particle filters, distributed using MP

## Installation

To install the package, open [Julia's REPL](https://docs.julialang.org/en/v1/stdlib/REPL/),
enter the package manager with `]`, then run the command
To install the latest stable version of the package, open the [Julia
REPL](https://docs.julialang.org/en/v1/stdlib/REPL/), enter the package manager
with `]`, then run the command

```
add https://github.com/Team-RADDISH/ParticleDA.jl.git
add ParticleDA.jl
```

If you plan to develop the package (make changes, submit pull requests, etc), in
the package manager mode run this command

```
dev https://github.com/Team-RADDISH/ParticleDA.jl.git
dev ParticleDA
```

This will automatically clone the repository to your local directory
Expand Down

2 comments on commit 87c0324

@giordano
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/82970

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.1 -m "<description of version>" 87c03246bbfd62a20696ed12ffa4bf5998afb56c
git push origin v1.0.1

Please sign in to comment.